doxygen:声明中的html格式与C中的定义

时间:2013-11-04 17:18:50

标签: c doxygen

问题与Using Doxygen with C, do you comment the function prototype or the definition? Or both?有关。

doxygen格式化使我的.h文件中的声明及其注释首先出现,然后是我的.c文件中的定义及其注释。好。

唉,是否有一些参数,如\ param [in]或\ return [in],我可以在html输出的.c定义之前使用,以直观地表示“现在我正在描述实现”?它可以在左侧放置粗体,甚至可以更改颜色以在视觉上将其设置为关闭。明显的\ implements标签不会这样做。

我查看了生成的doxygen html代码,并且没有明显的css类可以更改。所以我可能应该使用http://www.doxygen.nl/manual/commands.html中的标签。别人怎么用?

1 个答案:

答案 0 :(得分:0)

一个不理想但具有简单性的选择是使用\note命令。

使用\note前缀描述实现的段落将导致它们在输出中显示带有绿色黄色侧边栏。您可以更改CSS中的颜色。后续\note段落将作为单独的段落保留,但只有一个标题和侧边栏。

缺点是该部分为注意:。这可能是您可能接受的,也可能是不可接受的。

可以使用\xrefitem,这样您就可以将文本更改为实施:,但相当合理的是,它还会生成一个条目一个单独的交叉引用页面 - 这可能是不可取的。可能有一种方法可以禁用交叉索引,但manual中没有关于它的内容。

我假设您正在生成仅供内部使用的文档;某种形式的技术手册或许?在这种情况下,'Note'选项可能是最快最简单的解决方案。

编辑:我刚刚找到\remark命令。基本上相当于没有侧边栏的\note,但关联的标题备注可能更适合您的应用。您可以在CSS中添加侧边栏。