Отсутствующие комментарии в стиле Javadoc в сгенерированной документации Doxygen - PullRequest
Новая
       35

Отсутствующие комментарии в стиле Javadoc в сгенерированной документации Doxygen

0 голосов
/ 13 июня 2018

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

/**
 * Takes string formatted plugin information and processes it.
 * @param id_orig a constant
 * @param group_orig a constant
 * @see get_or_add_info(...)
 * @return SUCCESS and FAILURE macros. 
 */
static RETCODE import_process_element(...) { ...}

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

/**
 * @file
 * @brief A super great file.
 * @author Tinus Lorvolds
 */

JAVA_AUTOBRIEF включено.Doxyfile версии 1.8.14 для Windows 7 с исходными файлами на языке C.Я уверен, что это что-то простое, но я застрял на нем довольно долго.Спасибо за вашу помощь и терпение.

Вот соответствующая разница между моей конфигурацией и стандартной: 

OPTIMIZE_OUTPUT_FOR_C  = YES
JAVADOC_AUTOBRIEF      = YES
EXTRACT_STATIC         = YES
RECURSIVE              = YES

Решение ниже.

1 Ответ

0 голосов
/ 13 июня 2018

Проблема была с самим источником.Директива препроцессора скрывала источник от Doxygen.Если все перечисленные выше настройки установлены правильно, попробуйте отключить эту функцию: 

ENABLE_PREPROCESSING   = NO
...