Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentación por doxygen #47

Open
RicardoRB opened this issue Nov 9, 2013 · 3 comments
Open

Documentación por doxygen #47

RicardoRB opened this issue Nov 9, 2013 · 3 comments
Labels

Comments

@RicardoRB
Copy link
Contributor

Creo que unas actualizaciones que podríamos hacer es el uso de documentación por doxygen en todas las clases, ya que he visto que algunas lo tienen y otras no. Y en estás no están documentadas las variables, sólo los métodos (no sé si os parecería correcto documentar también las variables).

Yo podría hacerme cargo de actualizar la documentación hasta la fecha

@adrigm
Copy link
Contributor

adrigm commented Nov 9, 2013

@RicardoRB, es la idea ir documentando todo estilo doxygen.

Genial si te encargas de lo que falta, para las variables usa la nomenclatura de las tres barras /// y para las funciones la que hay en las otras clases.

@edoren
Copy link

edoren commented Nov 10, 2013

La verdad no se nada de el uso de Doxygen, algún tutorial bueno que recomienden?

@adrigm
Copy link
Contributor

adrigm commented Nov 10, 2013

Se trata de un sistema que auto-documenta una API con los comentarios de la misma. Se escriben en el código unos comentarios con unas ciertas reglas y doxygen te genera una documentación a partir de ella. Mira su página web, está todo muy clarito.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants