DoxyGen文档ROS文件

时间:2017-11-20 16:19:57

标签: doxygen ros

ROS使用3种文件格式来定义进程之间的远程接口。它们是简单的消息定义,可以在构建时转换为您想要的任何语言。我们只使用C ++。

我希望生成的文档仍然包含它们。这些特殊文件允许使用#前缀(如python)进行注释。所以我最初的想法就是用这个来写这样的python样式doxygen评论:

## \struct hlr::FibanacciGoal
#  \brief Untill which to calculate the fibonacci sequence

## \var order
#  \brief Until what number to calculate the sequence.
int32 order
---
## \struct hlr::FibanacciFeedback
#  \brief feedback blabla

## \var sequence
#  \brief The currently calculate feedback.
int32[] sequence
---
## \struct hlr::FibanacciResult
#  \brief The final result

## \var sequence
#  \brief The final calculated feedback.
int32[] sequence

我想要的是,在我的文档中,三个结构生成如上所定义。但即使明确添加到源中,它们也完全没有被doxygen检测到。我不知道为什么会这样,以及如何以其他方式实现这一目标

0 个答案:

没有答案