Документирование переменных с Doxygen в C

Question

Документирование переменных с Doxygen в C

Код:

#include <stdio.h>

/*
 * \var int iOne
 * \brief Integer 1
 */
/*
 * \var int iTwo
 * \brief Integer 2
 */
/*
 * \var int iThree
 * \brief Integer 3
 */

/**
 * \brief Imitates a sheep.
 */
void sheep();

/**
 * \brief Main function for test code
 */
int main() {
    int iOne, iTwo, iThree;
    iOne = 1;
    iTwo = 2;
    iThree = 3;
    printf("%d %d %d", iOne, iTwo, iThree);

    return 0;
}

void sheep() {
    printf("Meeeh");
}

Это не генерирует описания для iOne, iTwo и iThree хотя это было моим намерением. Как я фиксирую это?

7

objective-c c doxygen

задан Magnus 6 February 2012 в 12:37

1 ответ

Другие вопросы по тегам:

objective-c c doxygen

Похожие вопросы:

score 8 · Accepted Answer

Вам необходимо открыть комментарии как комментарии Doxygen с / ** .

Это может быть понятнее сделать это, хотя:

int main() {
   /** \brief Integer 1 */
   int iOne;
   /** \brief Integer 2 */
   int iTwo;
   /** \brief Integer 3 */
   int iThree;
   /** ... and so on ... */
}

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