2011-03-08 11 views
8

Me gustaría crear un comando personalizado en Doxygen similar a \fn\param o \var.Crear un nuevo comando personalizado que se agregará a una sección en Doxygen

Por ejemplo, me gustaría ser capaz de crear un comando \option la que yo usaría de la siguiente manera:

/** 
    \option option_1 This is the first option. 
    \option option_2 This is the second option. 
*/ 

Con una salida como:

        Opciones:
                option_1 Esta es la primera opción.
                option_2 Esta es la segunda opción.




Un simple sustitución de alias no funciona. Por ejemplo, con este alias:

ALIASES = option="\par Options:\n" 

me sale el siguiente resultado:

        Opciones:
                opción_1 Esta es la primera opción.

        Opciones:
                option_2 Esta es la segunda opción.

Que no es lo que estoy buscando.


Recompensa:

Si se necesita cualquier aclaración adicional, véase mi pregunta: Doxygen - Create custom command

Respuesta

3

Si bien no está tan limpio como @param, puede emular un comportamiento similar con los siguientes alias:

ALIASES += options="<dl class="params"><dt>Options</dt><dd><table class="params">" 
ALIASES += option{2}="<tr><td class="paramname">\1</td><td>\2</td></tr>" 
ALIASES += endoptions="</table></dd></dl>" 

Los alias se pueden utilizar de la siguiente manera para producir la salida que está buscando:

/** 
* @options 
* @option{ option_1, This is the first option. } 
* @option{ option_2, This is the second option. } 
* @endoptions 
*/ 

Nota: Este es el HTML-céntrico y probablemente no producirá una salida razonable para otros formatos.

0

Parece que xrefitem podría hacer lo que quiera como respondida en esta pregunta anterior: Custom tags with Doxygen

+1

Lo que hace ese comando es crear una página separada para el comando dado y crear enlaces a esa página. El resultado de la documentación del método es aproximadamente el mismo que en mi alias simple. Definitivamente no es lo que estoy buscando. – amicitas

Cuestiones relacionadas