В нашем проекте мы имеем следующую структуру каталогов:
gambit
gambit/Utils
gambit/Utils/include/gambit/Utils
gambit/Utils/src
gambit/Core
gambit/Core/include/gambit/Core
gambit/Core/src
...
и так далее. Мы делаем это так, чтобы в наших файлах была чистая структура include, например:
#include "gambit/Utils/somefile.hpp"
, где мы компилируем с -Igambit/Utils/include
и так далее. Теперь я хотел бы добавить документацию doxygen для каждого уровня в этом дереве каталогов. Но как я могу это сделать? Кажется, я не могу избежать warning: \dir command matches multiple directories
. Например, скажем, я хочу задокументировать корневой каталог, у меня, похоже, нет другого выбора, кроме как написать, например,
/// \dir gambit
/// \brief Root of GAMBIT source tree
///
/// Some long description
Однако это дает мне warning: \dir command matches multiple directories
, поскольку он соответствует корневому каталогу, а также обоим из этих каталогов:
gambit/Utils/include/gambit
gambit/Core/include/gambit
Но это корневой каталог проекта, я не могу ничего добавить к пути, чтобы сделать его уникальным, потому что добавить нечего! Та же проблема существует для неоднозначностей gambit/Utils
и gambit/Core
. Есть ли способ сказать doxygen, чтобы он предпочел более короткие спички? В настоящее время кажется, что он просто выбирает между своими вариантами. Документирование других каталогов с их длинными именами, похоже, не помогает, похоже, что doxygen не использует эту информацию для возврата и разрешения предыдущих конфликтов.