HTML-документация, сгенерированная doxygen для перечислений, перечисляет перечисление слева и документацию справа. Однако мне нужна довольно подробная документация для каждого значения, а некоторые имена очень длинные, из-за чего правый столбец с документацией отображается далеко вправо, и это выглядит очень плохо. Нет ли возможности сделать так, чтобы документация для каждого значения отображалась ниже или выше значения, а не справа?
Документирование перечислений с помощью 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 мне не удалось воспроизвести описанное вами поведение. Я получаю документацию по перечислению, аналогичную документации по списку параметров.
То, что я наблюдаю, согласуется с документацией Doxygen для \enum command и отрисовка.