Python和Cpp文件未包含在文档中

时间:2018-09-20 14:18:32

标签: doxygen ros

简介

我最近尝试使用Doxygen记录我的ROS项目。我没有找到一种很好的方法来使用rosdoc_lite包“干净地”为我的所有自定义包创建文档。干净地讲,我听说所有文档都链接在一个大文档中(我希望这很清楚)。

因此,我尝试使用Doxygen为我的所有ROS项目生成一个文档。现在,我对如何组织我的文档不是一个好主意,但是我在学习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标记。

此外,我尝试将State.py文件中的@file标记更改为@package。 Doxygen创建一个空的名称空间。

我一直在解决这个问题,我也不知道该如何处理。

如果您需要更多信息,请问我!

谢谢你!

1 个答案:

答案 0 :(得分:0)

当我尝试举一个问题的小例子时,我发现我有两个同名的文件位于两个不同的包(#noob)中。我用google搜索,发现Doxygen不能自动区分两个包中的两个文件。我在Doxygen文档中按要求进行操作(请参见此处:http://www.doxygen.nl/commands.html#cmdfile),一切正常。 (每个@file标记必须是唯一的。如果需要,请在文件中添加目录路径。)

结论:我的糟糕。 -_-

相关问题