Doxygen生成'man'但没有SYNOPSIS字段

时间:2015-12-06 13:48:59

标签: bash shell doxygen man

我已经自定义了Doxygen来解析Bash脚本(.sh)。我输出man个文件。

唯一的问题是,我不知道如何添加SYNOPSIS。这条线总是存在于Linux中,我想利用它,但我不知道如何。

有人知道如何实现这个目标吗?

1 个答案:

答案 0 :(得分:0)

您可以通过编辑Doxyfile并修改SYNOPSIS标记以阅读

来创建自己的ALIASES =命令
ALIASES = "synopsis=@par SYNOPSIS\n"

有了这个,您可以将命令@synopsis(或\synopsis)放在文档中,这将产生一个标题为

的用户定义段落
  

<强>概要

正如doxygen documentation for the ALIAS tag中所指出的,您可以将\n放在别名的值部分中以插入换行符。