Файл Python & Cpp не включен в документацию

Question

Intro

Недавно я попытался использовать Doxygen для документирования своего проекта ROS.Я не нашел хорошего способа создать документацию для всего моего собственного пакета «чисто» с помощью пакета rosdoc_lite.В чистом виде, я слышал, есть все документы, связанные в одну большую документацию (надеюсь, это достаточно ясно).

Поэтому я пытаюсь сгенерировать документ для всего моего проекта ROS с Doxygen.У меня сейчас нет хорошей идеи, как структурировать мою документацию, но я структурирую ее, изучая Doxygen.Я рад получить ваш совет, если вы хотите поделиться возможной структурой или способом использования rosdoc_lite для всего пакета.

Моя проблема

Моя главная проблема - я не могу достичьчтобы все мои файлы h / py были задокументированы.Проблема возникает в одном конкретном месте.

Include
├── RStatus
│   ├── __init__.py
│   ├── Side.h #Documented
│   ├── State.h #Shown in file list but not documented
│   ├── State.py #Not shown in file list
└── Services
    ├── __init__.py
    ├── RobotServices.h #Documented
    ├── RobotServices.py #Documented

Каждый файл имеет тег @file, @brief и @author в начале файла.

Кроме того, я попытался изменитьтег @file для @package в файле State.py.Doxygen создает пустое пространство имен.

Я застрял в этой проблеме и не знаю, как с ней справиться.

Если вам нужна дополнительная информация, спросите меня!

Спасибо за вашувремя!

Answer 1

Когда я попытался привести небольшой пример своей проблемы, я обнаружил, что у меня есть 2 файла с одинаковым именем, расположенные в двух разных пакетах (#noob).Я погуглил его и обнаружил, что Doxygen не может автоматически различать два файла в двух пакетах.Я сделал так, как просят в Doxygen docs (см. Здесь: http://www.doxygen.nl/commands.html#cmdfile) и все работает. (Каждый тег @file должен быть уникальным. При необходимости добавьте dirpath к файлу.)

В заключение:Мой плохой. -_-