Есть ли способ продолжить списки doxygen через несколько блоков комментариев? - PullRequest
Новая
       12

Есть ли способ продолжить списки doxygen через несколько блоков комментариев?

2 голосов
/ 08 января 2010

По сути, я пытаюсь сделать код документа следующим образом: 

//Description of Step 1
DoStep1_1();
DoStep1_2();
...
//Description of Step 2
DoStep2_1();
DoStep2_2();

Я хочу, чтобы два блока комментариев превратились в упорядоченный список в выводе Doxygen. Я прочитал документацию по созданию списков, и я понимаю, что я могу просто использовать HTML-теги, но похоже, что между тегами, которые будут сгенерированы, генерируется дополнительная информация, которая приводит к появлению пробелов между двумя элементами. В конечном счете, я бы не хотел использовать теги HTML; то есть я бы предпочел просто использовать 

/*!
  -# Description of Step 1
*/
DoStep1_1();
DoStep1_2();
...
/*!
  -# Description of Step 2
*/
DoStep2_1();
DoStep2_2();

или что-то в этом роде. Это вообще возможно?

EDIT: Итак, я, возможно, не описал результаты, которые я получаю, и результаты, которые я хочу. HTML-код, сгенерированный из приведенного выше кода, выглядит примерно так:

  1. Описание шага 1

  2. Описание Step2

Обратите внимание, что есть два тега абзаца, которые мне не нужны, поскольку они приводят к появлению нежелательных пробелов.

1 Ответ

0 голосов
/ 11 января 2010

Конечно, это возможно. Я использую это успешно. Для получения более подробной информации прочитайте мой ответ на этот вопрос: Как получить возможность извлекать комментарии изнутри функции в doxygen?

РЕДАКТИРОВАТЬ: после прочтения вашего фактического и ожидаемого результата

К сожалению, я не нашел способа избавиться от пробелов между элементами списка.

...