我们可以在doxygen文档中创建自己的字段吗?

时间:2014-07-07 09:31:54

标签: c doxygen

我是doxygen的氧气所以如果我问一个基本的问题,请原谅。我已经完成了完整的文档,但我自己也找不到解决方案。这是我的代码中的内容:

typedef struct{
  uint32_t event;
  void (*action)(void);
} CommandChain;

CommandChain commandRepo[] = {
  {.event = 0, .action = NULL},
  {.event = 1, .action = Start_Timer},
  {.event = 2, .action = Start_Gps}
}

其中action与我在别处定义的函数相对应。我需要创建一个XML输出,其中我有一个Event字段和一个相应的Action。我需要它以可解析的格式。喜欢:@event_id 2 @triggers Gps 所以,我可以检查哪个事件会触发什么动作。

PS。我知道'@'用于doxygen中的命令,只是用来使我的观点更加清晰。

1 个答案:

答案 0 :(得分:0)

是的,请参阅doxygen's Custom Commands

  

以下是带有单个参数的别名定义示例:

     

ALIASES += l{1}="\ref \1"

上面添加了对带有单个参数的@l命令的支持,该参数在输出中扩展为\ref \1,其中\1是参数文本。我想你可以用它来构建你需要的东西。