Estas últimas semanas he estado programando un poco en C++, por aquello de recordar todo lo que subconscientemente he ido olvidando (o quizá no tan subconscientemente). Esta vez estoy usando librerías para todo, se acabó eso de sudar la gota gorda, que tampoco tengo mucho tiempo que gastar.
El caso es que, de cara a utilizarlo, voy a utilizar un lenguaje de script (de hecho, ya he empezado a hacer algunos bindings) y me entra una duda, ¿cómo voy a documentarlo?. Doxygen está muy bien cuando documentas un código de un lenguaje que conoce y cuando documentas funciones que existen en el código. Pero ahora yo tengo funciones todas del mismo tipo (solo cambian en el nombre) pero que en el sistema de script tendrán un número de parámetros determinado y un valor de retorno. Pero eso en el código de C++ no aparece reflejado a simple vista pues, como muchos ya sabréis, el sistema de script se comunica con la parte de C++ a través de una pila, por lo que doxygen no se entera de nada de esto.
¿Qué debería utilizar para documentar la API que estoy creando en el script? Lo más decente que se me ocurre es hacerla a mano, o quizás intentar seguir apañando el doxygen a ver si consigo algo más decente. ¿Alguien me puede iluminar el camino?
- 9 de Febrero de 2009 a las 4:07 pm
Loki dice:
Yo optaría, en principio, por documentar usando el mismo sistema que utilice el lenguaje de script en cuestión para su documentación oficial.
Miguel Herrero dice:
Realmente no se qué utilizan :S
Tienen un CHM con la documentación, pero en el código fuente no veo ninguna documentación especial ni nada. Doxygen, Natural Docs,… no hay nada “documentable” ahíLo único que se me ocurre es que los hagan a mano…
Alagtriste dice:
No lo he probrado pero quizá es lo que buscas: LuaDoc
Miguel Herrero dice:
Se agradece, tiene buena pinta para documentar archivos Lua. Pero lo que yo busco es documentar las funciones en C que voy a bindear en Lua.
De todas formas, creo que he encontrado una manera de apañar el Doxygen… cuanto obtenga resultados los publicaré aquí.

