html - doxygen を使用した列挙型の文書化

Question

The html documentation generated by doxygen for enums lists the enum to the left and the documentation to the right. However I need quite detailed documentation for each value and some of the names are very long thus making the right column with the documentation appear far out to the right and it looks very bad. Is there no possibility to make the documentation for each value appear below or above the value instead of to the right ?

Answer 1

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 生成ファイル:

Answer 2

doxygen 1.5.5 では、説明されている動作を再現できませんでした。パラメータリストのドキュメントに似た列挙型のドキュメントを取得します。

私が観察したことは、\enum コマンドとそのレンダリングに関する Doxygen のドキュメントと一致しています。