2009-02-13 63 views
4

由doxygen for enums生成的html文档列出了左边的枚举和右边的文档。不过,我需要对每个值进行非常详细的文档编制,而且其中一些名称很长,因此使文档中的右列出现在右侧,看起来非常糟糕。是否不可能使每个值的文档显示在值的下方或上方而不是右侧?使用doxygen记录枚举

回答

0

随着doxygen 1.5.5,我没有成功地重现你描述的行为。我得到一个类似于参数列表文档的枚举文档。

我观察到的结果与\enum commandits rendering的Doxygen文档一致。

+0

是的,它是一致的,我只是想知道,如果它是可以改变的,因为默认的行为不会在我的情况很好地工作。在示例渲染(您提供的链接)中,您可以看到枚举本身的文档位于顶部,而文档位于右侧。 – Zitrax 2009-02-24 13:17:14

+0

我再次尝试过,感谢您的评论,我现在明白了这个问题。从Doxygen的例子中,我添加了一个长V3V3V3 ...到AnotherEnum。行为与您描述的完全相同。不幸的是,我不知道解决方法。 – mouviciel 2009-02-24 13:49:07

0

我也不能重现这一点。你可以发布枚举和它的相关注释与doxyfile(doxygen配置)?也许是一个pastebin网址?

7

我正在使用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  <br> 
    /// Did gyre and gimble in the wabe;   <br> 
    /// All mimsy were the borogoves,    <br> 
    /// And the mome raths outgrabe.    <br> 
    /// "Beware the Jabberwock, my son!   <br> 
    /// The jaws that bite, the claws that catch! <br> 
    /// Beware the Jubjub bird, and shun   <br> 
    /// 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 generated doc for test.h