Documentación de espacios de nombres que abarcan varios archivos doxygen

Question

Considere que tengo 2 archivos de encabezado.

// HEADER 1 
/** 
* Doc for Foo here? 
*/ 
namespace Foo { 
    class This {...}; 
} 

& &

// HEADER 2 
/** 
* Doc for Foo here? 
*/ 
namespace Foo { 
    class That {...}; 
} 

¿Cómo debo manejar esto cuando se documentan con Doxygen?

Answer 1

Quizás ninguno.

Por ejemplo, imagine que tiene "<root>/utility/header1.hpp" que tiene su contenido en namespace utility y "<root>/utility/header2.hpp" que también lo hace.

Puede agregar un archivo: "<root>/utility.hpp" que documenta el espacio de nombres de la utilidad. Puede poner esto en la parte superior #error Documentation only. para asegurarse de que no esté incluido accidentalmente.

Pero yo recomendaría al menos hacer algún archivo fuera de la manera de mantenerlo en un lugar sano juicio (y no se mezcla en forma aleatoria con alguna clase.)

Answer 2

encontrar el mejor lugar para la documentación, si está en uno de esos archivos u otro completamente. Use un bloque de comentario con la etiqueta espacio de nombres de Doxygen:

/** 
* @namespace Foo 
* Documentation for Foo here. More docs for Foo here, 
* and down here. 
*/ 

Docs aquí: http://www.stack.nl/~dimitri/doxygen/commands.html#cmdnamespace