diff options
| author | Ralf Habacker <ralf.habacker@freenet.de> | 2007-03-14 00:16:05 +0000 | 
|---|---|---|
| committer | Ralf Habacker <ralf.habacker@freenet.de> | 2007-03-14 00:16:05 +0000 | 
| commit | c01a63299e1ebcf9193a11c484e0a551487f3257 (patch) | |
| tree | 39290d7e8c416e15238b8ab52a80c649c6a62db6 | |
| parent | d372907895ffed3a2df06146d5dcc8601eab04dc (diff) | |
* cmake: added doxygen support
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | cmake/CMakeLists.txt | 6 | ||||
| -rw-r--r-- | cmake/Doxyfile.cmake | 181 | ||||
| -rw-r--r-- | cmake/doc/CMakeLists.txt | 14 | ||||
| -rw-r--r-- | cmake/modules/FindDoxygen.cmake | 3 | 
5 files changed, 203 insertions, 5 deletions
| @@ -1,3 +1,7 @@ +2007-03-14 Ralf.Habacker  <ralf.habacker@freenet.de> + +	* cmake: add doxygen support +  2007-03-13  Ralf.Habacker  <ralf.habacker@freenet.de>  	* dbus/dbus-sysdeps-util-win.c (dbus_become_daemon):  diff --git a/cmake/CMakeLists.txt b/cmake/CMakeLists.txt index 9eb65b2e..e682a17b 100644 --- a/cmake/CMakeLists.txt +++ b/cmake/CMakeLists.txt @@ -228,11 +228,6 @@ OPTION(DBUS_DISABLE_CHECKS "Disable public API sanity checking" OFF)  #AC_ARG_ENABLE(xml-docs, AS_HELP_STRING([--enable-xml-docs],[build XML documentation (requires xmlto)]),enable_xml_docs=$enableval,enable_xml_docs=auto)  #xmldocs missing -#AC_ARG_ENABLE(doxygen-docs, AS_HELP_STRING([--enable-doxygen-docs],[build DOXYGEN documentation (requires Doxygen)]),enable_doxygen_docs=$enableval,enable_doxygen_docs=auto) -if(DOXYGEN) -  OPTION(DBUS_ENABLE_DOXYGEN_DOCS "build DOXYGEN documentation (requires Doxygen)" ON) -endif(DOXYGEN) -  #AC_ARG_ENABLE(gcov, AS_HELP_STRING([--enable-gcov],[compile with coverage profiling instrumentation (gcc only)]),enable_gcov=$enableval,enable_gcov=no)  OPTION(DBUS_GCOV_ENABLED "compile with coverage profiling instrumentation (gcc only)" OFF)  if(DBUS_GCOV_ENABLED) @@ -450,6 +445,7 @@ if (DBUS_BUILD_TESTS)  	add_subdirectory( test )  endif (DBUS_BUILD_TESTS)  add_subdirectory( tools ) +add_subdirectory( doc )  OPTION(DBUS_INSTALL_SYSTEM_LIBS "install required system libraries" OFF) diff --git a/cmake/Doxyfile.cmake b/cmake/Doxyfile.cmake new file mode 100644 index 00000000..9bdfde84 --- /dev/null +++ b/cmake/Doxyfile.cmake @@ -0,0 +1,181 @@ +# Doxyfile 0.1 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME           = D-Bus +PROJECT_NUMBER         = @VERSION@ +OUTPUT_DIRECTORY       = api +OUTPUT_LANGUAGE        = English +EXTRACT_ALL            = NO +EXTRACT_PRIVATE        = NO +EXTRACT_STATIC         = NO +HIDE_UNDOC_MEMBERS     = NO +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 +STRIP_CODE_COMMENTS    = YES +CASE_SENSE_NAMES       = YES +SHORT_NAMES            = NO +HIDE_SCOPE_NAMES       = NO +VERBATIM_HEADERS       = YES +SHOW_INCLUDE_FILES     = YES +JAVADOC_AUTOBRIEF      = YES +INHERIT_DOCS           = YES +INLINE_INFO            = YES +SORT_MEMBER_DOCS       = YES +DISTRIBUTE_GROUP_DOC   = NO +TAB_SIZE               = 8 +GENERATE_TODOLIST      = YES +GENERATE_TESTLIST      = YES +GENERATE_BUGLIST       = YES +ALIASES                =  +ENABLED_SECTIONS       =  +MAX_INITIALIZER_LINES  = 30 +OPTIMIZE_OUTPUT_FOR_C  = YES +SHOW_USED_FILES        = YES +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET                  = YES +WARNINGS               = YES +WARN_IF_UNDOCUMENTED   = YES +WARN_FORMAT            =  +WARN_LOGFILE           =  +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT                  = @top_srcdir@/dbus +FILE_PATTERNS          = *.c *.h +RECURSIVE              = YES +#EXCLUDE                = test + +# If the value of the INPUT tag contains directories, you can use the  +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude  +# certain files from those directories. + +EXCLUDE_PATTERNS       = Makefile.* ChangeLog CHANGES CHANGES.* README \ +                         README.* *.png AUTHORS DESIGN DESIGN.* *.desktop \ +                         DESKTOP* COMMENTS HOWTO magic NOTES TODO THANKS + +# The EXAMPLE_PATH tag can be used to specify one or more files or  +# directories that contain example code fragments that are included (see  +# the \include command). + +EXAMPLE_PATH           =  +EXAMPLE_PATTERNS       =  +EXAMPLE_RECURSIVE      = NO +IMAGE_PATH             =  +INPUT_FILTER           =  +FILTER_SOURCE_FILES    = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER         = YES +INLINE_SOURCES         = NO +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION    = 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_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      = NO +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 +MAN_EXTENSION          = .3dbus +MAN_LINKS              = YES +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML           = NO +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor    +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING   = YES +MACRO_EXPANSION        = YES +EXPAND_ONLY_PREDEF     = YES +SEARCH_INCLUDES        = YES +INCLUDE_PATH           =  +INCLUDE_FILE_PATTERNS  =  +PREDEFINED             = "DBUS_BEGIN_DECLS=" 			\ +			 "DBUS_END_DECLS=" 			\ +			 "DOXYGEN_SHOULD_SKIP_THIS" 		\ +                         "DBUS_GNUC_DEPRECATED="                \ +			 "_DBUS_DEFINE_GLOBAL_LOCK(name)="	\ +			 "_DBUS_GNUC_PRINTF(from,to)=" +SKIP_FUNCTION_MACROS   = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references    +#--------------------------------------------------------------------------- +TAGFILES               =  +GENERATE_TAGFILE       =  +ALLEXTERNALS           = NO +PERL_PATH              =  +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool    +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS         = YES +HAVE_DOT               = NO +CLASS_GRAPH            = YES +COLLABORATION_GRAPH    = YES +TEMPLATE_RELATIONS     = YES +HIDE_UNDOC_RELATIONS   = YES +INCLUDE_GRAPH          = YES +INCLUDED_BY_GRAPH      = YES +GRAPHICAL_HIERARCHY    = YES +DOT_PATH               =  +DOTFILE_DIRS           =  +MAX_DOT_GRAPH_WIDTH    = 640 +MAX_DOT_GRAPH_HEIGHT   = 1024 +GENERATE_LEGEND        = YES +DOT_CLEANUP            = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine    +#--------------------------------------------------------------------------- +SEARCHENGINE           = NO diff --git a/cmake/doc/CMakeLists.txt b/cmake/doc/CMakeLists.txt new file mode 100644 index 00000000..88ef67a8 --- /dev/null +++ b/cmake/doc/CMakeLists.txt @@ -0,0 +1,14 @@ +find_package(Doxygen) + +if(DOXYGEN_EXECUTABLE) +  OPTION(DBUS_ENABLE_DOXYGEN_DOCS "build DOXYGEN documentation (requires Doxygen)" ON) +endif(DOXYGEN_EXECUTABLE) + + +set (top_srcdir ${CMAKE_SOURCE_DIR}/..) +configure_file(${CMAKE_SOURCE_DIR}/Doxyfile.cmake ${CMAKE_BINARY_DIR}/Doxyfile ) +if (DBUS_ENABLE_DOXYGEN_DOCS) +    add_custom_target(doc  +        COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile +    ) +endif (DBUS_ENABLE_DOXYGEN_DOCS) diff --git a/cmake/modules/FindDoxygen.cmake b/cmake/modules/FindDoxygen.cmake new file mode 100644 index 00000000..1767901e --- /dev/null +++ b/cmake/modules/FindDoxygen.cmake @@ -0,0 +1,3 @@ + +find_program(DOXYGEN_EXECUTABLE NAMES doxygen DOC "doxygen executable") +mark_as_advanced(DOXYGEN_EXECUTABLE) | 
