doxygen为枚举生成的html文档列出了左侧的枚举和右侧的文档。但是我需要为每个值提供非常详细的文档,并且一些名称非常长,因此使文档右侧列显示在右侧,看起来非常糟糕。是否有可能使每个值的文档显示在值的下方或上方而不是右侧?
答案 0 :(得分: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生成文件:
答案 1 :(得分:0)
使用doxygen 1.5.5,我没有成功再现你描述的行为。我得到一个类似于参数列表文档的枚举文档。
我观察到的内容与\enum command和its rendering的Doxygen文档一致。
答案 2 :(得分:0)
我也无法重现这一点。你可以用doxyfile(doxygen配置)发布枚举及其相关注释吗?也许是一个pastebin URL?