簡體   English   中英

Doxygen忽略標簽

[英]Doxygen ignores tags

我是doxygen的新手,所以遇到了一些問題。 我想在文檔中添加\\ param,\\ brief等標簽,但由於某種原因,生成的html頁面僅顯示函數和類的聲明,但不包含我在源文檔中放入的任何信息。

現在,docu如下所示:

/************************************************************************************
 * \fn  void Synthesizer::setDecay(float decayLength_ms);
 *
 * \brief   Sets the decay-parameter. The decay determines the length of a note.
 *
 *
 * \param   decay   The decay length in the scope [0,1]. Values outside this scope won't be catched.
************************************************************************************/
void setDexay(float decayLength_ms);

這是我的doxygen配置:

# Doxyfile 1.2.7 
#---------------------------------------------------------------------------
# General configuration options
#--------------------------------------------------------------------------- 
PROJECT_NAME           = Node 
PROJECT_NUMBER         = 1 
OUTPUT_DIRECTORY       =  ../../Documentation/ 
OUTPUT_LANGUAGE        = English 
EXTRACT_ALL            = YES 
EXTRACT_PRIVATE        = NO 
EXTRACT_STATIC         = YES 
HIDE_UNDOC_MEMBERS     = YES 
HIDE_UNDOC_CLASSES     = NO 
BRIEF_MEMBER_DESC      = YES 
REPEAT_BRIEF           = YES 
ALWAYS_DETAILED_SEC    = NO 
FULL_PATH_NAMES        = NO 
STRIP_FROM_PATH        =  
INTERNAL_DOCS          = NO 
CLASS_DIAGRAMS         = YES 
SOURCE_BROWSER         = NO 
INLINE_SOURCES         = NO 
STRIP_CODE_COMMENTS    = YES 
CASE_SENSE_NAMES       = YES 
SHORT_NAMES            = NO 
HIDE_SCOPE_NAMES       = NO 
VERBATIM_HEADERS       = YES 
SHOW_INCLUDE_FILES     = YES 
JAVADOC_AUTOBRIEF      = NO 
INHERIT_DOCS           = YES 
INLINE_INFO            = YES 
SORT_MEMBER_DOCS       = YES 
DISTRIBUTE_GROUP_DOC   = NO 
TAB_SIZE               = 8 
ENABLED_SECTIONS       =  
GENERATE_TODOLIST      = YES 
GENERATE_TESTLIST      = YES 
GENERATE_BUGLIST       = YES 
ALIASES                =  
MAX_INITIALIZER_LINES  = 30 
OPTIMIZE_OUTPUT_FOR_C  = NO 
SHOW_USED_FILES        = YES 
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#--------------------------------------------------------------------------- 
QUIET                  = NO 
WARNINGS               = YES 
WARN_IF_UNDOCUMENTED   = YES 
WARN_FORMAT            =  
WARN_LOGFILE           =  
#---------------------------------------------------------------------------
# configuration options related to the input files
#--------------------------------------------------------------------------- 
INPUT                  = . 
FILE_PATTERNS          = *.hpp *.h *.cpp 
RECURSIVE              = YES 
EXCLUDE                =  
EXCLUDE_PATTERNS       =  
EXAMPLE_PATH           =  
EXAMPLE_PATTERNS       =  
IMAGE_PATH             =  
INPUT_FILTER           =  
FILTER_SOURCE_FILES    = NO 
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#--------------------------------------------------------------------------- 
ALPHABETICAL_INDEX     = NO 
COLS_IN_ALPHA_INDEX    = 5 
IGNORE_PREFIX          =  
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#--------------------------------------------------------------------------- 
GENERATE_HTML          = YES 
HTML_OUTPUT            =  
HTML_HEADER            =  
HTML_FOOTER            =  
HTML_STYLESHEET        =  
HTML_ALIGN_MEMBERS     = YES 
GENERATE_HTMLHELP      = NO 
GENERATE_CHI           = NO 
BINARY_TOC             = NO 
TOC_EXPAND             = NO 
DISABLE_INDEX          = NO 
ENUM_VALUES_PER_LINE   = 4 
GENERATE_TREEVIEW      = YES 
TREEVIEW_WIDTH         = 250 
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#--------------------------------------------------------------------------- 
GENERATE_LATEX         = NO 
LATEX_OUTPUT           =  
COMPACT_LATEX          = NO 
PAPER_TYPE             = a4wide 
EXTRA_PACKAGES         =  
LATEX_HEADER           =  
PDF_HYPERLINKS         = NO 
USE_PDFLATEX           = NO 
LATEX_BATCHMODE        = NO 
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#--------------------------------------------------------------------------- 
GENERATE_RTF           = NO 
RTF_OUTPUT             =  
COMPACT_RTF            = NO 
RTF_HYPERLINKS         = NO 
RTF_STYLESHEET_FILE    =  
RTF_EXTENSIONS_FILE    =  
#---------------------------------------------------------------------------
# configuration options related to the man page output
#--------------------------------------------------------------------------- 
GENERATE_MAN           = YES 
MAN_OUTPUT             =  
MAN_EXTENSION          =  
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor   
#--------------------------------------------------------------------------- 
ENABLE_PREPROCESSING   = YES 
MACRO_EXPANSION        = NO 
EXPAND_ONLY_PREDEF     = NO 
SEARCH_INCLUDES        = NO 
INCLUDE_PATH           =  
INCLUDE_FILE_PATTERNS  =  
PREDEFINED             =  
EXPAND_AS_DEFINED      =   
TAGFILES               =  
GENERATE_TAGFILE       =  
ALLEXTERNALS           = NO 
PERL_PATH              =  
#---------------------------------------------------------------------------
# Configuration options related to the dot tool   
#--------------------------------------------------------------------------- 
HAVE_DOT               = NO 
CLASS_GRAPH            = YES 
COLLABORATION_GRAPH    = YES 
INCLUDE_GRAPH          = YES 
INCLUDED_BY_GRAPH      = YES 
GRAPHICAL_HIERARCHY    = YES 
DOT_PATH               =  
MAX_DOT_GRAPH_WIDTH    = 1024 
MAX_DOT_GRAPH_HEIGHT   = 1024 
GENERATE_LEGEND        = YES 
DOT_CLEANUP            = YES 
#---------------------------------------------------------------------------
# Configuration::addtions related to the search engine   
#--------------------------------------------------------------------------- 
SEARCHENGINE           = NO 
CGI_NAME               =  
CGI_URL                =  
DOC_URL                =  
DOC_ABSPATH            =  
BIN_ABSPATH            =  
EXT_DOC_PATHS          = 

我想念什么嗎? 就像我說的那樣,它會在html頁面中生成具有每個函數的每個類,但是它們沒有記錄。

謝謝!

您錯過了一些非常基本的東西。 注釋塊必須/**開頭,doxygen才能將其提取。

只有兩顆星。 您不得打字三個,也不要打字一個,除了您然后進行兩個。 七十來了。

(希望您已經看到了這個

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM