martinpaurabe / TP4_IdS

Trabajo Practico de DoxyGen y
Other
0 stars 0 forks source link

No es necesario (ni recomendable) repetir la documentación en el archivo `.c` #2

Open evolentini opened 4 months ago

evolentini commented 4 months ago

Los miembros públicos se documentan en el archivo de cabecera .h y no es recomendable repetir la documentación en el archivo .c porque, como todo duplicado, puede prestarse a contradicciones si se corrige una versión de la documentación y otra no.

https://github.com/martinpaurabe/TP4_IdS/blob/798c2c8f96637f165fa1febea2d12751eb4aa7ac/src/gpio.c#L89-L92

martinpaurabe commented 4 months ago

Perfecto, muchas gracias por las correcciones.

Slds MP

El lun, 24 jun 2024 a las 21:15, Esteban Volentini (< @.***>) escribió:

Los miembros públicos se documentan en el archivo de cabecera .h y no es recomendable repetir la documentación en el archivo .c porque, como todo duplicado, puede prestarse a contradicciones si se corrige una versión de la documentación y otra no.

https://github.com/martinpaurabe/TP4_IdS/blob/798c2c8f96637f165fa1febea2d12751eb4aa7ac/src/gpio.c#L89-L92

— Reply to this email directly, view it on GitHub https://github.com/martinpaurabe/TP4_IdS/issues/2, or unsubscribe https://github.com/notifications/unsubscribe-auth/AWITM5UJTXYPMXHS4FFJA2TZJCZCDAVCNFSM6AAAAABJ2YJQQWVHI2DSMVQWIX3LMV43ASLTON2WKOZSGM3TCMZUGI2DGMI . You are receiving this because you are subscribed to this thread.Message ID: @.***>