Rain's Blog

Doxygen是一个文档生成工具，支持多种语言，如C++, C, Java, Objective-C, Python, IDL以及PHP，C#和D。可以生成多种文档格式，常见的有HTML、LaTeX、RTF、XML、MAN等。我常常用来将一些开源项目的源码转换成chm文档，这样阅读的时候非常方便。最近已经更新到1.5.1颁本了，可以去官方网站下载使用。 下面是我使用的一个config的例子： # Doxyfile 1.5.0 #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- PROJECT_NAME           = "Spring Framework Source 2.0 - Rain's" PROJECT_NUMBER         = 2.0 OUTPUT_DIRECTORY       = /temp CREATE_SUBDIRS         = YES OUTPUT_LANGUAGE        = English USE_WINDOWS_ENCODING   = YES BRIEF_MEMBER_DESC      = YES REPEAT_BRIEF           = YES ABBREVIATE_BRIEF       = "The $name class" \                          "The $name widget" \                          "The $name file" \                          is \                          provides \                          specifies \                          contains \                          represents \                          a \                          an \                          the ALWAYS_DETAILED_SEC    = NO INLINE_INHERITED_MEMB  = NO FULL_PATH_NAMES        = YES STRIP_FROM_PATH        = "/" STRIP_FROM_INC_PATH    = "/" SHORT_NAMES            = NO JAVADOC_AUTOBRIEF      = NO MULTILINE_CPP_IS_BRIEF = NO DETAILS_AT_TOP         = YES INHERIT_DOCS           = YES SEPARATE_MEMBER_PAGES  = NO TAB_SIZE               = 4 ALIASES                =  OPTIMIZE_OUTPUT_FOR_C  = NO OPTIMIZE_OUTPUT_JAVA   = YES BUILTIN_STL_SUPPORT    = NO DISTRIBUTE_GROUP_DOC   = NO SUBGROUPING            = YES #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL            = NO EXTRACT_PRIVATE        = NO EXTRACT_STATIC         = NO EXTRACT_LOCAL_CLASSES  = YES EXTRACT_LOCAL_METHODS  = NO HIDE_UNDOC_MEMBERS     = YES HIDE_UNDOC_CLASSES     = YES HIDE_FRIEND_COMPOUNDS  = NO HIDE_IN_BODY_DOCS      = NO INTERNAL_DOCS          = NO CASE_SENSE_NAMES       = NO HIDE_SCOPE_NAMES       = NO SHOW_INCLUDE_FILES     = YES INLINE_INFO            = YES SORT_MEMBER_DOCS       = YES SORT_BRIEF_DOCS        = 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       = YES FILE_VERSION_FILTER    =  #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- QUIET                  = NO WARNINGS               = YES WARN_IF_UNDOCUMENTED   = YES WARN_IF_DOC_ERROR      = YES WARN_NO_PARAMDOC       = NO WARN_FORMAT            = "$file:$line: $text" WARN_LOGFILE           =  #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- INPUT                  = /org  FILE_PATTERNS          = *.java  RECURSIVE              = YES EXCLUDE                =  EXCLUDE_SYMLINKS       = NO EXCLUDE_PATTERNS       =  EXAMPLE_PATH           =  EXAMPLE_PATTERNS       = * EXAMPLE_RECURSIVE      = NO IMAGE_PATH             =  INPUT_FILTER           =  FILTER_PATTERNS        =  FILTER_SOURCE_FILES    = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- SOURCE_BROWSER         = YES INLINE_SOURCES         = NO STRIP_CODE_COMMENTS    = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION    = YES USE_HTAGS              = NO VERBATIM_HEADERS       = YES #--------------------------------------------------------------------------- # 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 HTML_FILE_EXTENSION    = .html HTML_HEADER            =  HTML_FOOTER            =  HTML_STYLESHEET        =  HTML_ALIGN_MEMBERS     = YES GENERATE_HTMLHELP      = YES CHM_FILE               = /spring-2.0.chm HHC_LOCATION           = "C:/Program Files/HTML Help Workshop/hhc.exe" 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           = latex LATEX_CMD_NAME         = latex MAKEINDEX_CMD_NAME     = makeindex COMPACT_LATEX          = NO PAPER_TYPE             = a4wide EXTRA_PACKAGES         =  LATEX_HEADER           =  PDF_HYPERLINKS         = NO USE_PDFLATEX           = NO LATEX_BATCHMODE        = NO LATEX_HIDE_INDICES     = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- GENERATE_RTF           = NO RTF_OUTPUT             = rtf COMPACT_RTF            = NO RTF_HYPERLINKS         = NO RTF_STYLESHEET_FILE    =  RTF_EXTENSIONS_FILE    =  #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- GENERATE_MAN           = NO MAN_OUTPUT             = man MAN_EXTENSION          = .3 MAN_LINKS              = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- GENERATE_XML           = NO XML_OUTPUT             = xml XML_SCHEMA             =  XML_DTD                =  XML_PROGRAMLISTING     = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- GENERATE_AUTOGEN_DEF   = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- GENERATE_PERLMOD       = NO PERLMOD_LATEX          = NO PERLMOD_PRETTY         = YES PERLMOD_MAKEVAR_PREFIX =  #--------------------------------------------------------------------------- # Configuration options related to the preprocessor    #--------------------------------------------------------------------------- ENABLE_PREPROCESSING   = YES MACRO_EXPANSION        = NO EXPAND_ONLY_PREDEF     = NO SEARCH_INCLUDES        = YES INCLUDE_PATH           = NO INCLUDE_FILE_PATTERNS  =  PREDEFINED             =  EXPAND_AS_DEFINED      =  SKIP_FUNCTION_MACROS   = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references    #--------------------------------------------------------------------------- TAGFILES               =  GENERATE_TAGFILE       =  ALLEXTERNALS           = NO EXTERNAL_GROUPS        = YES PERL_PATH              = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool    #--------------------------------------------------------------------------- CLASS_DIAGRAMS         = YES HIDE_UNDOC_RELATIONS   = YES HAVE_DOT               = NO CLASS_GRAPH            = YES COLLABORATION_GRAPH    = YES GROUP_GRAPHS           = YES UML_LOOK               = NO TEMPLATE_RELATIONS     = NO INCLUDE_GRAPH          = YES INCLUDED_BY_GRAPH      = YES CALL_GRAPH             = NO GRAPHICAL_HIERARCHY    = YES DIRECTORY_GRAPH        = YES DOT_IMAGE_FORMAT       = png DOT_PATH               =  DOTFILE_DIRS           =  MAX_DOT_GRAPH_WIDTH    = 1024 MAX_DOT_GRAPH_HEIGHT   = 1024 MAX_DOT_GRAPH_DEPTH    = 1000 DOT_TRANSPARENT        = NO DOT_MULTI_TARGETS      = NO GENERATE_LEGEND        = YES DOT_CLEANUP            = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine    #--------------------------------------------------------------------------- SEARCHENGINE           = NO