使用 doxygen 在类页面中创建部分
我想记录一个具有许多方法的类。 我的方法被分组:例如,我有四种方法允许我更改几何形式的形状,其他五种方法允许我填充形状,等等。
我想知道是否有办法使用“@section”之类的东西来达到我的目的,因为在 doxygen 文档中(http://www.doxygen.nl/manual/commands.html#cmdsection) 我发现该命令仅在相关页面文档中有效。
如何为类创建逻辑部分?
预先感谢您的回复。
I want to document a class that has many methods.
My methods are grouped: for example, I've four methods that allows me to change the shape of a geometric form, other five methods that allows me to fill the shape, and so on.
I'd like to know if there's a way to use something like '@section' for my purpouse, because in doxygen documentation (http://www.doxygen.nl/manual/commands.html#cmdsection) I've seen that this command work only in related page documentation.
How can I create logical section for classes?
Thanks in advance for your replies.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
看看
@name
,它是专门为方法分组而设计的。或者,如果您希望方法组显示在单独的页面上,则可以使用
@defgroup
和@addtogroup
。有关这两个命令的示例,请参阅 http://www.doxygen.org/grouping.html。
Have a look at
@name
, which is specifically made to group methods.Alternatively you can use
@defgroup
and@addtogroup
if you want the group of methods to appear on a separate page.See http://www.doxygen.org/grouping.html for examples of both commands.