4

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

4

2 回答 2

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 为 test.h 生成的文档

于 2012-02-03T14:34:01.713 回答
0

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

我观察到的与\enum 命令及其渲染的 Doxygen 文档一致。

于 2009-02-24T11:08:07.920 回答