Как смочь извлечь комментарии из функции в doxygen?

Я не знаю для C, но я делаю это каждый день в Objective-C, где у меня есть такие комментарии, как :

/// This method perform the following operations:
- (void) myMethodWith: (id) anObjectArgument
{
    /// - do op1
    [self op1];

    /// - do op2
    op2(anObjectArgument);
}

, который отображается как:

Этот метод выполняет следующие операции:

• do op1

• do op2

Редактировать: следующий комментарий Даны Сан, касающийся моего понимания документации Doxygen и почему это не противоречит моему опыту.

Я понимаю и истолковываю документацию Doxygen, это не противоречит цитате , предоставленной Аароном Саарела . В начале ссылки, которую он предоставляет, есть параграф о внутренней документации:

Для каждого элемента кода есть два (или в некоторых случаях три) типа описания, которые вместе образуют документация: краткое описание и подробное описание, оба необязательный. Для методов и функций есть также третий тип описание, так называемый "в теле" описание, которое состоит из объединение всех блоков комментариев находится в теле метода или function.

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

По моему мнению, абзац, цитируемый Аароном, относится к документации, которая обычно ставится перед объявлением или реализацией функции или метода. Это тот, который описывает параметры, возвращаемые значения и так далее. Эта документация заголовка не может быть помещена в тело функции или метода.

Но подробная документация, касающаяся каждого шага алгоритма внутри тела, прекрасно обрабатывается Doxygen.

Может быть, вместо этого вы могли бы привести код функции в качестве примера. http://www.doxygen.nl/manual/commands.html#cmdexample

Комментарии внутри кода предназначены для объяснения конкретного фрагмента реализации, понятного другому программисту, а не функции функции, о которой читают пользователи.

Если это должно быть задокументировано для пользователей, это должно быть сделано ouside функциональным блоком на комментарии, определяющем интерфейс (подпись, а также предварительные условия, постусловия, примеры использования или все, что вы считаете необходимым) .