5
Usamos doxygen para documentar nuestras clases. Me gustaría documentar explícitamente que una clase ha generado constructores y/o destructores, para indicar que lo he pensado y decidido que, por ejemplo, copiar usando el constructor de copia generada es seguro. Sin embargo, el constructor/destructor no está declarado y, por lo tanto, doxygen no sabe a qué función pertenece la documentación. ¿Hay formas de hacer que doxygen incluya comentarios de función incluso si la función nunca se declara?cómo documentar constructores generados en doxygen
//! The Foo class documentation
class Foo {
//! @fn Foo(const Foo&)
//! Generated copy constructor OK to use
//! method documentation
void method();
}
Además, no me gustaría escribir la firma de los archivos generados en absoluto.
Supongo que mi otra opción es simplemente describirlo en el encabezado de la clase. ¿Hay algún otro enfoque?
¿De verdad ve alguna razón para documentar el constructor de copias? Quiero decir que es obvio lo que hace, y si está permitiendo el uso del constructor generado, entonces usted, como autor, obviamente está de acuerdo con eso. –
buen ejemplo de por qué herramientas como Doxygen son incapaces de producir documentación * útil *. Simplemente dígale al usuario que la clase se puede copiar. – jalf