Documentación por doxygen

genbetadev / Genbeta-Dev-Engine

Desarrollo de un Game Engine básico sobre C++ y SFML 2.1

MIT License

63 stars 32 forks source link

Documentación por doxygen #47

Open RicardoRB opened 10 years ago

RicardoRB commented 10 years ago

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 commented 10 years ago

@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 commented 10 years ago

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

adrigm commented 10 years ago

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.