tutorial example comment code c++ documentation doxygen

c++ - comment - doxygen python example



Documentando funciones en C++ con Doxygen (4)

Este patrón funcionó bien para nosotros.

/*! Convert counts to kg for the reservoir. /param counts The A/D counts to convert.` /return The calculated kg based on the parameter. */ float RES_ConvertCountsToValue(uint_16 counts);

Tengo un proyecto en el que estoy usando Doxygen para generar documentación. La documentación de las clases está bien, pero también tengo algunas funciones que uso en main () para crear objetos, etc. También me gustaría incluirlas en mi documentación, pero no he pensado cómo hacerlo. ¿Alguna sugerencia?

Las entidades que son miembros de clases solo están documentadas si su clase está documentada. Las entidades declaradas en el ámbito del espacio de nombres solo se documentan si su espacio de nombres está documentado. Las entidades declaradas en el alcance del archivo solo se documentan si su archivo está documentado.

Entonces, para documentar una función gratuita en el espacio de nombres global, también necesita una línea como esta en algún lugar del archivo de encabezado en el que se declara:

/** @file */

O así:

/*! /file */

Me gusta este patrón

/////////////////////////////////////////////////////////////////////// /// /brief setX /// /param x offset of the image. /// /return a new image as an QImage. ///////////////////////////////////////////////////////////////////////// QImage setX(int x);