Как дать описание для каталога в Doxygen

Question

Я работаю с Doxygen для документирования моего проекта. Я знаю, используя приведенные ниже команды Doxygen, мы можем дать описание исходных файлов.

/** 
* \file example.cpp 
* \brief Implementation of example functions 
*/ 

Есть ли способ дать описание каталога/папки в Doxygen?

Answer 1

Использовать команду doxygen . Я задал подобный вопрос how to link to documentation of directory, в котором я показываю

/// \dir cpp/vtutil 
///  
/// \brief Brief description of the dir cpp/vtutil goes here 
/// 
/// \details A more detailed description goes here. 

Это работает, чтобы предоставить документацию каталога. В моем первоначальном вопросе у меня возникли проблемы с использованием \ref для ссылки на документацию по каталогу. После того, как я выкапывал и экспериментировал, мне удалось заставить его работать. Я прокомментировал в своем ответе, что Doxygen довольно прощающий или гибкий с путём, используемым при документировании каталога с командой \dir, но он довольно придирчив, ссылаясь на него с помощью команды \ref.