diff options
author | David King <davidk@openismus.com> | 2009-08-12 14:12:53 +0200 |
---|---|---|
committer | Jonathon Jongsma <jjongsma@gnome.org> | 2009-08-13 11:08:51 -0500 |
commit | de4e75a5e588ab8689bfe405391ff3c788c94018 (patch) | |
tree | 4648ad2ecb1db0da4087e398f1748fccc77b502a /docs | |
parent | 06de63b184325531c76270205c7392ff8c93466d (diff) |
Switch to mm-common documentation build infrastructure
* .gitignore: Add new generated documentation files.
* Makefile.am: Remove old documentation generation build.
* configure.ac:
* docs/reference/Makefile.am: Remove, with switch to non-recursive
documentation build.
* data/cairomm-1.0.pc.in:
* docs/Makefile.am: Switch to new documentation build infrastructure
from mm-common.
* docs/reference/Doxyfile.in: Modernise and disable several unused
features of the Doxygen output.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 15 | ||||
-rw-r--r-- | docs/reference/Doxyfile.in | 169 |
2 files changed, 111 insertions, 73 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index be6a753..9b51ce1 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,13 +1,10 @@ -SUBDIRS = reference +include $(top_srcdir)/cairomm/filelist.am -doc-clean-recursive: - list='$(SUBDIRS)'; for subdir in $$list; do \ - test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) doc-clean); \ - done +book_name = $(CAIROMM_MODULE_NAME) +doc_input = $(addprefix $(top_srcdir)/cairomm/,$(files_extra_h)) -doc-clean: doc-clean-recursive +htmlrefpub = http://www.cairographics.org/documentation/$(book_name)/reference/ -doc-rebuild: doc-clean all - -.PHONY: doc-clean doc-clean-recursive doc-rebuild +include $(top_srcdir)/build/doc-reference.am +dist_noinst_DATA += reference/cairomm-header.html diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in index 6e44b49..a10cc2e 100644 --- a/docs/reference/Doxyfile.in +++ b/docs/reference/Doxyfile.in @@ -1,12 +1,13 @@ -# Doxyfile 1.5.3 +# Doxyfile 1.5.8 +# @configure_input@ #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = cairomm -PROJECT_NUMBER = @GENERIC_VERSION@ -OUTPUT_DIRECTORY = +PROJECT_NAME = @PACKAGE_NAME@ +PROJECT_NUMBER = @CAIROMM_API_VERSION@ +OUTPUT_DIRECTORY = reference CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES @@ -14,54 +15,66 @@ REPEAT_BRIEF = YES ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = "@abs_top_builddir@/cairomm/" \ + "@abs_top_srcdir@/cairomm/" +STRIP_FROM_INC_PATH = "@abs_top_builddir@/cairomm/" \ + "@abs_top_srcdir@/cairomm/" SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = YES INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 8 ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +EXTENSION_MAPPING = BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES +TYPEDEF_HIDES_STRUCT = NO +SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL = YES EXTRACT_PRIVATE = NO -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO +HIDE_FRIEND_COMPOUNDS = YES +HIDE_IN_BODY_DOCS = YES INTERNAL_DOCS = NO CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = NO INLINE_INFO = YES SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = YES -SORT_BY_SCOPE_NAME = NO -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES +SORT_BRIEF_DOCS = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = YES +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = NO +GENERATE_BUGLIST = NO GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 2 SHOW_USED_FILES = YES -SHOW_DIRECTORIES = YES -FILE_VERSION_FILTER = +SHOW_DIRECTORIES = NO +SHOW_FILES = NO +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -71,20 +84,30 @@ WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text " -WARN_LOGFILE = undocumented.txt +WARN_LOGFILE = reference/doxygen.log #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = @top_srcdir@/cairomm +INPUT = INPUT_ENCODING = UTF-8 -FILE_PATTERNS = *.h +FILE_PATTERNS = RECURSIVE = NO -EXCLUDE = @top_srcdir@/cairomm/private.h @top_srcdir@/cairomm/context_private.h +EXCLUDE = "@abs_top_srcdir@/cairomm/private.h" \ + "@abs_top_srcdir@/cairomm/context_private.h" EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = @top_srcdir@/examples -EXAMPLE_PATTERNS = +EXCLUDE_SYMBOLS = _* \ + adaptor_trait \ + basic_filebuf \ + basic_streambuf \ + binary_function \ + char_traits \ + internal \ + pair \ + unary_function +EXAMPLE_PATH = "@abs_top_srcdir@/examples" +EXAMPLE_PATTERNS = *.cc \ + *.h EXAMPLE_RECURSIVE = YES IMAGE_PATH = INPUT_FILTER = @@ -96,38 +119,51 @@ FILTER_SOURCE_FILES = NO SOURCE_BROWSER = NO INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO REFERENCES_LINK_SOURCE = YES USE_HTAGS = NO -VERBATIM_HEADERS = YES +VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = NO COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = @srcdir@/cairomm-header.html -HTML_FOOTER = -HTML_STYLESHEET = @srcdir@/cairomm.css +HTML_HEADER = "@abs_top_srcdir@/docs/reference/cairomm-header.html" +HTML_FOOTER = +HTML_STYLESHEET = "@abs_top_srcdir@/docs/reference/cairomm.css" HTML_ALIGN_MEMBERS = YES -GENERATE_HTMLHELP = NO HTML_DYNAMIC_SECTIONS = NO -CHM_FILE = -HHC_LOCATION = +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_BUNDLE_ID = org.doxygen.Project +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = GENERATE_CHI = NO +CHM_INDEX_ENCODING = BINARY_TOC = NO TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = NO +ENUM_VALUES_PER_LINE = 1 +GENERATE_TREEVIEW = NONE TREEVIEW_WIDTH = 250 +FORMULA_FONTSIZE = 10 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -139,8 +175,8 @@ COMPACT_LATEX = NO PAPER_TYPE = a4wide EXTRA_PACKAGES = LATEX_HEADER = -PDF_HYPERLINKS = NO -USE_PDFLATEX = NO +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- @@ -166,7 +202,7 @@ GENERATE_XML = NO XML_OUTPUT = xml XML_SCHEMA = XML_DTD = -XML_PROGRAMLISTING = YES +XML_PROGRAMLISTING = NO #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -179,15 +215,17 @@ PERLMOD_LATEX = NO PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = DOXYGEN_IGNORE_THIS \ +INCLUDE_PATH = "@abs_top_builddir@/cairomm/" \ + "@abs_top_srcdir@/cairomm/" +INCLUDE_FILE_PATTERNS = *.h +PREDEFINED = __cplusplus \ + DOXYGEN_IGNORE_THIS \ CAIRO_HAS_XLIB_SURFACE \ CAIRO_HAS_XLIB_XRENDER_SURFACE \ CAIRO_HAS_WIN32_SURFACE \ @@ -203,41 +241,44 @@ PREDEFINED = DOXYGEN_IGNORE_THIS \ EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = cairomm_doxygen_tags +TAGFILES = @DOXYGEN_TAGFILES@ +GENERATE_TAGFILE = "reference/@CAIROMM_MODULE_NAME@.tag" ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -PERL_PATH = /usr/bin/perl +EXTERNAL_GROUPS = NO +PERL_PATH = @PERL@ #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -MSCGEN_PATH = +CLASS_DIAGRAMS = NO +MSCGEN_PATH = HIDE_UNDOC_RELATIONS = NO HAVE_DOT = YES +DOT_FONTNAME = FreeSans +DOT_FONTSIZE = 10 +DOT_FONTPATH = CLASS_GRAPH = YES COLLABORATION_GRAPH = NO -GROUP_GRAPHS = NO +GROUP_GRAPHS = YES UML_LOOK = NO -TEMPLATE_RELATIONS = NO +TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = NO INCLUDED_BY_GRAPH = NO CALL_GRAPH = NO CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES +DIRECTORY_GRAPH = NO DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = +DOT_PATH = +DOTFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = NO +DOT_MULTI_TARGETS = YES GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Options related to the search engine #--------------------------------------------------------------------------- SEARCHENGINE = NO |