当前位置:  开发笔记 > 编程语言 > 正文

使用doxygen记录枚举

如何解决《使用doxygen记录枚举》经验,为你挑选了1个好方法。

doxygen为枚举生成的html文档列出了左侧的枚举和右侧的文档.但是我需要为每个值提供非常详细的文档,并且一些名称非常长,因此使文档右侧列显示在右侧,看起来非常糟糕.是否有可能使每个值的文档显示在值的下方或上方而不是右侧?



1> pennyrave..:

我正在使用Doxygen 1.7.5.1.我有类似的情况......我有一个大约1000名成员的枚举,我是从电子表格生成的.我希望整数值向右移动,Doxygen位在成员上方.

我所做的只是使用成员名称上方的三重斜杠.对于多行注释,我在需要的地方插入了HTML换行符.我只做了第一节,但我认为这很明显.注意:第一行因周期而中断.后续行没有.

///
/// \file test.h
/// \brief Test of Doxygen enum commenting.
///

//! A test of Doxygen commenting.
typedef enum _DOXYGEN_TEST
{

    /// This is a single line comment.
    Member_001,                            //  1

    /// This is a mutli-line comment.
    /// 'Twas brillig, and the slithy toves       
/// Did gyre and gimble in the wabe;
/// All mimsy were the borogoves,
/// And the mome raths outgrabe.
/// "Beware the Jabberwock, my son!
/// The jaws that bite, the claws that catch!
/// Beware the Jubjub bird, and shun
/// The frumious Bandersnatch!" /// /// He took his vorpal sword in hand: /// Long time the manxome foe he sought-- /// So rested he by the Tumtum tree, /// And stood awhile in thought. /// /// And as in uffish thought he stood, /// The Jabberwock, with eyes of flame, /// Came whiffling through the tulgey wood, /// And burbled as it came! /// /// One, two! One, two! and through and through /// The vorpal blade went snicker-snack! /// He left it dead, and with its head /// He went galumphing back. /// /// "And hast thou slain the Jabberwock? /// Come to my arms, my beamish boy! /// O frabjous day! Callooh! Callay!" /// He chortled in his joy. /// /// 'Twas brillig, and the slithy toves /// Did gyre and gimble in the wabe; /// All mimsy were the borogoves, /// And the mome raths outgrabe. Member_002, // 2 } Doxygen_test;

生成的Doxygen生成的文件: Doxygen为test.h生成doc

推荐阅读
mobiledu2402851323
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有