HTML документацията, генерирана от doxygen за enums, изброява enum отляво и документацията отдясно. Въпреки това имам нужда от доста подробна документация за всяка стойност и някои от имената са много дълги, което прави дясната колона с документацията да изглежда далеч вдясно и изглежда много зле. Няма ли възможност документацията за всяка стойност да се показва под или над стойността вместо вдясно?
Документиране на енуми с помощта на doxygen
Отговори (2)
Използвам 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 1.5.5 не успях да възпроизведа поведението, което описвате. Получавам документация за enum, подобна на документацията за списък с параметри.
Това, което наблюдавам, е в съответствие с документацията на Doxygen за \enum команда и изобразяването му.