2009-02-13 100 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