Doxygen Как сделать общую документацию для папки

Question

Я хотел бы добавить описания для каждой папки, как указано на рисунке:

Это возможно?

Answer 1

Вы можете документировать папки с помощью команды \dir или @dir

https://www.stack.nl/~dimitri/doxygen/manual/commands.html

Документация на это не велика. Но я уже прошел время, чтобы выяснить, как это работает. В любой исходный файл вы можете добавить документацию для папки (или даже создать специальный файл для документации папки).

В твоем случае

/** \dir workspace
 *  \brief "Folder description that shows up where you want"
 *  \details More details to be displayed on the folder's page.
 */


/** \dir workspace/SWTtutotial
 *  \brief "Folder description that shows up where you want"
 *  \details More details to be displayed on the folder's page.
 */

Обратите внимание... следите за написанием слов "учебник";)

Примечание: я заметил ошибку, связанную с именами папок с общим суффиксом. Я получаю следующее предупреждение:

file.cpp:180: warning: \dir command matches multiple directories.
  Applying the command for directory /sources/
  Ignoring the command for directory /testsources/

Комментарий в строке 180, вызывающий это предупреждение

/**
 * \dir "sources"
 * \details Adding details later 3...
 */ //works but complains about also matching "testsources".  Doxygen Bug?

Я исправил это с помощью \dir /sources вместо кавычек. Это нормально, если в пути нет пробелов... в противном случае нам нужно исправить ошибку.