[libgdamm] Transition to mm-common documentation build
- From: Daniel Elstner <daniel src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [libgdamm] Transition to mm-common documentation build
- Date: Thu, 20 Aug 2009 14:58:17 +0000 (UTC)
commit bdbf1ce715e8808a7b3515c8e019b0df6f3a44d7
Author: Daniel Elstner <danielk openismus com>
Date: Thu Aug 20 15:57:50 2009 +0200
Transition to mm-common documentation build
* configure.ac (AC_CONFIG_FILES): Remove docs/reference/Makefile.am
from the list of output files.
(MM_ARG_WITH_TAGFILE_DOC): Reference the Doxygen tag files of
libstdc++, libsigc++ and glibmm.
* Makefile.am (SUBDIRS): Recurse into docs/ conditionally.
* docs/Makefile.am: Rewrite based upon the new mm-common build
infrastructure for the reference documentation.
* docs/reference/Doxyfile.in: Heavily modernize and adapt to the
new documentation build organization.
* docs/reference/glibmm_doxygen_tags: Delete redundant file.
* docs/reference/Makefile.am: Delete obsolete build file.
* docs/reference/README: ditto.
.gitignore | 3 +
ChangeLog | 19 +
Makefile.am | 7 +-
configure.ac | 10 +-
docs/Makefile.am | 43 +-
docs/reference/Doxyfile.in | 233 +-
docs/reference/Makefile.am | 70 -
docs/reference/README | 6 -
docs/reference/glibmm_doxygen_tags |17614 ------------------------------------
9 files changed, 217 insertions(+), 17788 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 9af2014..f3efb35 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,6 +17,9 @@ stamp-h?
/libtool
/libgdamm-*.tar.*
/docs/reference/Doxyfile
+/docs/reference/doxygen.log
+/docs/reference/libgdamm-*.devhelp2
+/docs/reference/libgdamm-*.tag
/docs/reference/html/
/examples/*/example
/libgda/libgdamm-*.pc
diff --git a/ChangeLog b/ChangeLog
index 90ba5eb..fb59fa6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,24 @@
2009-08-20 Daniel Elstner <danielk openismus com>
+ Transition to mm-common documentation build
+
+ * configure.ac (AC_CONFIG_FILES): Remove docs/reference/Makefile.am
+ from the list of output files.
+ (MM_ARG_WITH_TAGFILE_DOC): Reference the Doxygen tag files of
+ libstdc++, libsigc++ and glibmm.
+ (HAVE_BDB): Remove Automake conditional as it doesn't seem to be
+ used.
+ * Makefile.am (SUBDIRS): Recurse into docs/ conditionally.
+ * docs/Makefile.am: Rewrite based upon the new mm-common build
+ infrastructure for the reference documentation.
+ * docs/reference/Doxyfile.in: Heavily modernize and adapt to the
+ new documentation build organization.
+ * docs/reference/glibmm_doxygen_tags: Delete redundant file.
+ * docs/reference/Makefile.am: Delete obsolete build file.
+ * docs/reference/README: ditto.
+
+2009-08-20 Daniel Elstner <danielk openismus com>
+
Convert tools/ and libgda/ to new infrastructure
* Makefile.am (SUBDIRS): Skip the libgda/ subdirectory and recurse
diff --git a/Makefile.am b/Makefile.am
index 7d0c0f2..1f30a8f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -23,7 +23,12 @@ src_subdirs = tools libgda/src
else
src_subdirs =
endif
-SUBDIRS = $(src_subdirs) libgda/libgdamm examples docs
+if ENABLE_DOCUMENTATION
+doc_subdirs = docs
+else
+doc_subdirs =
+endif
+SUBDIRS = $(src_subdirs) libgda/libgdamm examples $(doc_subdirs)
libgdamm_includedir = $(includedir)/$(LIBGDAMM_MODULE_NAME)
libgdamm_include_HEADERS = libgda/libgdamm.h
diff --git a/configure.ac b/configure.ac
index 00c9ee8..3b1d3b5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -45,7 +45,6 @@ PKG_CHECK_MODULES([LIBGDAMM], [$LIBGDAMM_MODULES])
PKG_CHECK_EXISTS([libgda-bdb-4.0], [libgdamm_have_bdb=yes], [libgdamm_have_bdb=no])
AS_IF([test "x$libgdamm_have_bdb" = xyes],
[AC_DEFINE([HAVE_BDB], [1], [Define if the libgda-bdb plugin is available.])])
-AM_CONDITIONAL([HAVE_BDB], [test "x$libgdamm_have_bdb" = xyes])
MM_PKG_CONFIG_SUBST([GMMPROC_DIR], [--variable=gmmprocdir glibmm-2.4])
@@ -56,9 +55,9 @@ MM_ARG_ENABLE_WARNINGS([LIBGDAMM_WXXFLAGS],
[G GDA])
MM_ARG_ENABLE_DOCUMENTATION
-
-# Temporary dummy
-AM_CONDITIONAL([BUILD_REFERENCE], [false])
+MM_ARG_WITH_TAGFILE_DOC([libstdc++.tag], [mm-common-libstdc++])
+MM_ARG_WITH_TAGFILE_DOC([libsigc++-2.0.tag], [sigc++-2.0])
+MM_ARG_WITH_TAGFILE_DOC([glibmm-2.4.tag], [glibmm-2.4])
AC_CONFIG_FILES([
Makefile
@@ -70,8 +69,7 @@ AC_CONFIG_FILES([
tools/Makefile
docs/Makefile
- docs/reference/Makefile
- docs/reference/Doxyfile
+ docs/reference/Doxyfile
examples/Makefile
examples/simple/Makefile
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 51570ee..5242f39 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,9 +1,34 @@
-## Copyright (c) 2001
-## The libgdamm development team.
-
-## This voodoo stuff lets automake see the subdirs
-## without including them into recursive builds.
-if BUILD_REFERENCE
-SUBDIRS = reference
-endif
-DIST_SUBDIRS = reference
+## Copyright (c) 2009 Openismus GmbH <http://www.openismus.com/>
+##
+## This file is part of libgdamm.
+##
+## libgdamm is free software: you can redistribute it and/or modify it
+## under the terms of the GNU Lesser General Public License as published
+## by the Free Software Foundation, either version 2.1 of the License,
+## or (at your option) any later version.
+##
+## libgdamm is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+## See the GNU Lesser General Public License for more details.
+##
+## You should have received a copy of the GNU Lesser General Public License
+## along with this library. If not, see <http://www.gnu.org/licenses/>.
+
+include $(top_srcdir)/libgda/src/filelist.am
+include $(top_srcdir)/libgda/libgdamm/filelist.am
+
+libgdamm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
+
+book_name = $(LIBGDAMM_MODULE_NAME)
+doc_input = $(addprefix $(top_srcdir)/libgda/libgdamm/,$(libgdamm_files_h))
+
+# Override the web location to use the old-style path with redundant
+# directory components.
+htmlrefpub = http://www.gtkmm.org/docs/$(book_name)/docs/reference/html/
+
+include $(top_srcdir)/build/doc-reference.am
+
+dist_noinst_DATA += \
+ reference/libgdamm_header.html_fragment \
+ reference/libgdamm_footer.html_fragment
diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in
index 2b8d86f..b37e169 100644
--- a/docs/reference/Doxyfile.in
+++ b/docs/reference/Doxyfile.in
@@ -1,61 +1,94 @@
-# Doxyfile 1.4.0
+# Doxyfile 1.5.8
+# @configure_input@
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
-PROJECT_NAME = libgdamm
-PROJECT_NUMBER = @LIBGDAMM_VERSION@
-OUTPUT_DIRECTORY =
+DOXYFILE_ENCODING = UTF-8
+PROJECT_NAME = @PACKAGE_NAME@
+PROJECT_NUMBER = @LIBGDAMM_API_VERSION@
+OUTPUT_DIRECTORY = reference
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
-ABBREVIATE_BRIEF =
+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 = NO
-STRIP_FROM_PATH =
-STRIP_FROM_INC_PATH =
+FULL_PATH_NAMES = YES
+STRIP_FROM_PATH = "@abs_top_builddir@/libgda/" \
+ "@abs_top_srcdir@/libgda/" \
+ "@abs_top_builddir@/" \
+ "@abs_top_srcdir@/"
+STRIP_FROM_INC_PATH = "@abs_top_builddir@/libgda/" \
+ "@abs_top_srcdir@/libgda/" \
+ "@abs_top_builddir@/" \
+ "@abs_top_srcdir@/"
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
+QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
-DISTRIBUTE_GROUP_DOC = NO
+SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
-ALIASES =
+ALIASES = "since{2}=\xrefitem since_\1_\2 \"Since @PACKAGE_NAME@ \1.\2\" \"New API in @PACKAGE_NAME@ \1.\2\""
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
#---------------------------------------------------------------------------
@@ -65,59 +98,85 @@ WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
-WARN_LOGFILE =
+WARN_LOGFILE = reference/doxygen.log
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
-INPUT = @LIBGDAMM_DOXYGEN_INPUT@
-FILE_PATTERNS = *.h
+INPUT =
+INPUT_ENCODING = UTF-8
+FILE_PATTERNS =
RECURSIVE = NO
-EXCLUDE =
+EXCLUDE =
EXCLUDE_SYMLINKS = NO
-EXCLUDE_PATTERNS = */wrap_init.h
-EXAMPLE_PATH = @top_srcdir@/examples
-EXAMPLE_PATTERNS = *.h \
- *.cc
+EXCLUDE_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 = $(DOXYGEN_IMAGE_PATH)
-INPUT_FILTER =
-FILTER_PATTERNS =
+IMAGE_PATH =
+INPUT_FILTER =
+FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
-STRIP_CODE_COMMENTS = NO
-REFERENCED_BY_RELATION = YES
-REFERENCES_RELATION = YES
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION = NO
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS = NO
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
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 = libgdamm_header.html_fragment
-HTML_FOOTER = libgdamm_footer.html_fragment
-HTML_STYLESHEET =
+HTML_HEADER = "@abs_top_srcdir@/docs/reference/libgdamm_header.html_fragment"
+HTML_FOOTER = "@abs_top_srcdir@/docs/reference/libgdamm_footer.html_fragment"
+HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
+HTML_DYNAMIC_SECTIONS = NO
+GENERATE_DOCSET = NO
+DOCSET_FEEDNAME = "Doxygen generated docs"
+DOCSET_BUNDLE_ID = org.doxygen.Project
GENERATE_HTMLHELP = NO
-CHM_FILE =
-HHC_LOCATION =
+CHM_FILE =
+HHC_LOCATION =
GENERATE_CHI = NO
+CHM_INDEX_ENCODING =
BINARY_TOC = NO
TOC_EXPAND = NO
-DISABLE_INDEX = YES
+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 = 1
-GENERATE_TREEVIEW = NO
+GENERATE_TREEVIEW = NONE
TREEVIEW_WIDTH = 250
+FORMULA_FONTSIZE = 10
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
@@ -127,10 +186,10 @@ LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
-EXTRA_PACKAGES =
-LATEX_HEADER =
-PDF_HYPERLINKS = NO
-USE_PDFLATEX = NO
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = YES
+USE_PDFLATEX = YES
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
@@ -140,8 +199,8 @@ GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
-RTF_STYLESHEET_FILE =
-RTF_EXTENSIONS_FILE =
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
@@ -152,11 +211,11 @@ MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
-GENERATE_XML = YES
+GENERATE_XML = NO
XML_OUTPUT = xml
-XML_SCHEMA =
-XML_DTD =
-XML_PROGRAMLISTING = YES
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
@@ -167,59 +226,69 @@ GENERATE_AUTOGEN_DEF = NO
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
-PERLMOD_MAKEVAR_PREFIX =
+PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
+# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
-SEARCH_INCLUDES = NO
-INCLUDE_PATH =
-INCLUDE_FILE_PATTERNS =
-PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
- GTKMM_USING_STD(x)= \
- GTKMM_API \
- GTKMM_ATKMM_ENABLED \
- GLIBMM_VFUNCS_ENABLED \
- GLIBMM_PROPERTIES_ENABLED \
+SEARCH_INCLUDES = YES
+INCLUDE_PATH = "@abs_top_builddir@/libgda" \
+ "@abs_top_srcdir@/libgda"
+INCLUDE_FILE_PATTERNS = *.h
+PREDEFINED = __cplusplus \
+ DOXYGEN_SHOULD_SKIP_THIS \
+ "G_GNUC_CONST=" \
+ GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED \
GLIBMM_EXCEPTIONS_ENABLED \
- GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
-EXPAND_AS_DEFINED =
+ GLIBMM_HAVE_WIDE_STREAM \
+ GLIBMM_PROPERTIES_ENABLED \
+ GLIBMM_VFUNCS_ENABLED \
+ "LIBGDAMM_API="
+EXPAND_AS_DEFINED = LIBGDAMM_MAJOR_VERSION \
+ LIBGDAMM_MINOR_VERSION \
+ LIBGDAMM_MICRO_VERSION
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
-# Configuration::additions related to external references
+# Configuration::additions related to external references
#---------------------------------------------------------------------------
-TAGFILES = ../../../glibmm/docs/reference/glibmm_doxygen_tags
-GENERATE_TAGFILE = libgdamm_doxygen_tags
+TAGFILES = @DOXYGEN_TAGFILES@
+GENERATE_TAGFILE = "reference/@LIBGDAMM_MODULE_NAME tag"
ALLEXTERNALS = NO
-EXTERNAL_GROUPS = YES
-PERL_PATH = @PERL_PATH@
+EXTERNAL_GROUPS = NO
+PERL_PATH = @PERL@
#---------------------------------------------------------------------------
-# Configuration options related to the dot tool
+# Configuration options related to the dot tool
#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = YES
+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 = 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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
