C ++ Doxygen скрыть комментарии

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

Часто у меня есть такой код в одном из моих исходных файлов (.cpp):

///* OCBA P(CS) implementation for "max" problems */
//void OCBA_PCS() {
//
// Code goes here...
//
//}/*! OCBA minimize simulation cost for "max" problems */
void OCBA_SC() {
// Code goes here...
}

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

* OCBA P(CS) implementation for "max" problems */

в раздел подробной документации для OCBA_SC(), Как я могу предотвратить это?

Ниже приведены соответствующие настройки конфигурации Doxygen, которые я использую:

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
EXTRACT_ANON_NSPACES   = YES
HIDE_UNDOC_MEMBERS     = YES
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = YES
INTERNAL_DOCS          = NO
CASE_SENSE_NAMES       = NO
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
FORCE_LOCAL_INCLUDES   = YES
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS       =
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = YES
SHOW_DIRECTORIES       = NO
SHOW_FILES             = YES
SHOW_NAMESPACES        = YES
FILE_VERSION_FILTER    =
LAYOUT_FILE            =

1

Решение

Если вы просто прокомментируете // это не появится на Doxygen. Doxygen анализирует только комментарии, начиная с определенных токенов, таких как /** или же /*!,

Проанализированные токены описаны в Документация по кислороду.

4

Другие решения

Других решений пока нет …

По вопросам рекламы ammmcru@yandex.ru
Adblock
detector