¿Existe un "wiki" para editar comentarios doxygen?

Estoy trabajando en un motor de juego RTS de fuente abierta bastante grande ( Spring ). Recientemente agregué un montón de nuevas funciones de C ++ que puede invocar Lua, y me pregunto cómo es mejor documentarlas, y al mismo time, también estimular a la gente a escribir / actualizar documentation para muchos de los llamados Lua existentes.

Así que pensé que sería bueno si pudiera escribir la documentation inicialmente como comentarios doxygen cerca de las funciones de C ++, esto es fácil porque el cuerpo de la function obviamente define exactamente lo que hace la function. Sin embargo, me gustaría que la documentation sea mejorada por los desarrolladores de juegos que usan el motor, que generalmente tienen poca comprensión de git (el VCS que usamos) o C ++.

Por lo tanto, sería ideal si hubiera una manera de generar automáticamente apidocs desde el file C ++, pero también tener una interfaz web tipo wiki para permitir que una audiencia mucho más amplia actualice los comentarios, agregue ejemplos, etc.

Entonces, me pregunto, ¿existe una herramienta web que integre el formatting de estilo doxygen, edición tipo wiki para esos comentarios (preferiblemente sin permitir la edición de otras partes del file fuente) y git? (para enviar los comentarios cambiados a través de la interfaz web a una sucursal especial)

Nosotros los desarrolladores podríamos fusionar esta twig de vez en cuando para agregar las mejoras a la twig principal, y al mismo time cualquier mejora de los desarrolladores en la documentation terminaría en esta herramienta web con solo una fusión de la twig principal en este especial twig.

Todavía no he encontrado nada, dudo que este específico exista aún, por lo que cualquier sugerencia es bienvenida.

Esta es una idea realmente genial, y hace un par de años también tenía una gran necesidad de algo así. Lamentablemente, al less en aquel entonces, no pude encontrar algo así. Hacer una búsqueda rápida en sourceforge y freshmeat tampoco trae nada relacionado hoy.

Pero estoy de acuerdo en que una interfaz de wiki así para la documentation aportada por el usuario sería muy útil, sé con certeza que algo así se discutió recientemente también dentro de la comunidad de Lua (ver esto ).

Entonces, ¿tal vez podamos determinar los requisitos para elaborar un borrador / prototipo básico de trabajo?

Con suerte, esto nos llevaría a iniciar un proyecto de este tipo con un set mínimo de características y luego simplemente lanzarlo a la naturaleza como un proyecto de código abierto (por ejemplo, en sourceforge), para que otros usuarios puedan contribuir.

Idealmente, uno podría usar parches unificados para aplicar los cambios que se contribuyeron de esa manera. Además, probablemente tendría sentido restringir modificaciones solo para agregar / editar comentarios, en lugar de permitir modificaciones arbitrarias de text, esto probablemente podría implementarse usando una expresión regular simple.

Tal vez, uno podría implementar algo así modificando un software wiki existente (establecido) como mediawiki. O preferiblemente, algo que ya está usando git como un backend para propósitos de almacenamiento. Entonces, uno necesitaría principalmente atender esos comentarios al estilo de Doxygen, y proporcionar una interfaz simple en la parte superior.

Pensando en ello un poco más, DoxyGen ya proporciona soporte para generar documentation HTML, por lo que desde esa perspectiva podría ser realmente interesante ver cómo se podría extender DoxyGen, de modo que esté bien integrado con un back-end tan codificado que permita una fácil personalización de la documentation del código fuente embedded.

Esto probablemente se networkinguzca principalmente a proporcionar un script independiente con doxygen (por ejemplo, en python, php o perl) y luego incrustar formularios en la documentation HTML creada automáticamente, de modo que la documentation correcciones / aumentos se pueden enviar al script correspondiente a través de un browser , que a su vez escribiría cualquier modificación en la twig correspondiente.

A largo ploop, sería genial si tal script soportara diferentes types de backends (CVS, SVN o git), o al less se implementara de manera genérica, de modo que sea fácilmente extensible.

Entonces, si podemos llegar a un buen layout, incluso podría ser posible que tal modificación sea generalmente aceptada como una contribución al propio doxygen, lo que también daría mucho más exposition e impulso.

Incluso si la idea no se materializa directamente en un proyecto real, sería interesante ver a cuántos otros usuarios realmente les gusta la idea, de modo que posiblemente se pueda mencionar en el website de Doxygen Todo .

EDITAR: También puede consultar este artículo titulado "Documentation, Git and MediaWiki" .