online - ¿Cuál es la forma correcta de hacer referencia a un parámetro en Doxygen?
doxygen ubuntu (2)
Tengo la siguiente documentación de Doxygen para una función:
/**
@brief Does interesting things
@param[in] pfirst The first parameter: a barrel full of monkeys
@pre
"pfirst" must have been previously passed through BarrelFiller()
*/
Tenga en cuenta que pfirst es un parámetro y que se hace referencia en las condiciones previas.
Lo rodeé con comillas aquí porque quiero detenerlo del resto del texto. Pero sería bueno hacerlo de tal manera que Doxygen resaltará el comando y, preferiblemente, lo vinculará a la definición del parámetro. ¿Hay alguna forma de hacer esto?
Sería especialmente bueno si esto ocurriera utilizando solo la configuración predeterminada (o alteraciones menores de la misma).
Doxygen proporciona el comando /p para indicar que la siguiente palabra es un parámetro de la función. Lo usarías así:
... the /p x and /p y coordinates are used to ...
Creo que por defecto esto se representará usando una fuente de máquina de escribir. No creo que esto proporcione actualmente ninguna funcionalidad de enlace automático, pero podría potencialmente en el futuro.
Hay un comando relacionado, /a que se usa para marcar argumentos de miembros. Por defecto, se muestra con énfasis en el texto ( <em>arg</em> )
Puede encontrar más información sobre las diversas referencias de Doxygen Special Commands .
use el símbolo "#" delante del parámetro que desea referenciar:
#pfirst must have been previously passed through BarrelFiller()