Документирование перечислений с использованием doxygen

Question

HTML-документация, сгенерированная doxygen для перечислений, перечисляет перечисление слева и документацию справа. Однако мне нужно довольно подробную документацию для каждого значения, и некоторые имена очень длинные, поэтому правильный столбец с документацией выглядит очень вправо, и это выглядит очень плохо. Нет ли возможности сделать так, чтобы документация для каждого значения отображалась ниже или выше значения вместо правого?

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

Я тоже не могу воспроизвести это. Можете ли вы опубликовать enum и связанные с ним комментарии с помощью doxyfile (doxygen config)? Возможно, URL-адрес для вставки?

Answer 3

С doxygen 1.5.5 мне не удалось воспроизвести описанное вами поведение. Я получаю документацию enum, аналогичную документации по списку параметров.

То, что я наблюдаю, согласуется с документацией Doxygen для \ enum команды и ее рендеринга .