Doxygen Parámetro Punto culminante en pre-condición

Question

que tenga una cabecera Doxygen para una función de la siguiente manera:

/** Some description. 

    @param[in] grid1  First grid 
    @param[in] grid2  Second grid 

    @pre grid1 and grid2 must be of the same dimensions 
*/ 

me gustaría grid1 y grid2 que ser especialmente resaltadas en la sección de pre-condiciones de la documentación generada, ya que son parámetros. En mi opinión, debería poder hacer algo como

@pre #grid1 and #grid2 must be the same size 

Pero esto no funciona.

¿Alguna idea sobre cómo lograr esto?

Gracias!

Answer 1

Sería bueno si # se vinculó automáticamente a la definición del argumento de la función. Sin embargo, no puedo ver de todos modos hacer esto en la sección automatic link generation del manual de doxygen.

Después de haber examinado la fuente HTML de documentación, parece que los parámetros parecen tener un estilo simple como strong y con la clase paramname. Así que algo así como

@pre <strong class="paramname">grid1</strong> and 
    <strong class="paramname">grid2</strong> must be the same size. 

debería darle los resultados que desea. Claramente, esto es demasiado detallado para escribir cada vez. Sin embargo, usted debe ser capaz de definir una custom command, decir \paramname, para hacer esto por lo que sólo podría escribir

@pre \paramname{grid1} and \paramname{grid2} must be the same size. 

Editar: Esto se puede lograr con el archivo de configuración de alias

ALIASES += paramname{1}="<strong class="paramname">\1</strong>" 

Answer 2

Landed aquí buscando la respuesta, pero la encontré en otro lugar.

Use \p para indicar que la siguiente palabra es un parámetro de función.

Y, por supuesto, puede usar @ en lugar de \.

/** Some description. 

    @param[in] grid1  First grid 
    @param[in] grid2  Second grid 

    @pre @p grid1 and @p grid2 must be of the same dimensions 
*/ 

Ver Doxygen Special Commands reference.