[pangomm] Transition to mm-common documentation build
- From: Daniel Elstner <daniel src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [pangomm] Transition to mm-common documentation build
- Date: Tue, 11 Aug 2009 15:54:22 +0000 (UTC)
commit 49240e2f5a1d6f0b9fb0a9ea72b23792f25db305
Author: Daniel Elstner <danielk openismus com>
Date: Tue Aug 11 17:52:01 2009 +0200
Transition to mm-common documentation build
* configure.ac (AC_CONFIG_FILES): List docs/Makefile.am and
docs/reference/Doxyfile as output files.
* Makefile.am (SUBDIRS): Resurrect docs/ subdirectory.
* 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/Makefile_web.am_fragment: Delete obsolete file.
* docs/images/Makefile.am: ditto,
* docs/reference/Makefile.am: ditto,
* docs/reference/doxygen_to_devhelp.xsl: ditto,
* docs/reference/README: ditto.
* docs/reference/widget_hierarchy.{dia,html,png}: Delete files as
they belong to the documentation of the gtkmm module, not pangomm.
ChangeLog | 19 +++
Makefile.am | 2 +-
configure.ac | 1 +
docs/Makefile.am | 71 ++++++-----
docs/Makefile_web.am_fragment | 17 ---
docs/images/Makefile.am | 16 ---
docs/reference/.gitignore | 5 +
docs/reference/Doxyfile.in | 218 ++++++++++++++++++++-------------
docs/reference/Makefile.am | 109 ----------------
docs/reference/README | 6 -
docs/reference/doxygen_to_devhelp.xsl | 94 --------------
docs/reference/widget_hierarchy.dia | Bin 11486 -> 0 bytes
docs/reference/widget_hierarchy.html | 104 ----------------
docs/reference/widget_hierarchy.png | Bin 117224 -> 0 bytes
14 files changed, 197 insertions(+), 465 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 75d2dd9..2b38a9c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,24 @@
2009-08-11 Daniel Elstner <danielk openismus com>
+ Transition to mm-common documentation build
+
+ * configure.ac (AC_CONFIG_FILES): List docs/Makefile.am and
+ docs/reference/Doxyfile as output files.
+ * Makefile.am (SUBDIRS): Resurrect docs/ subdirectory.
+ * 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/Makefile_web.am_fragment: Delete obsolete file.
+ * docs/images/Makefile.am: ditto,
+ * docs/reference/Makefile.am: ditto,
+ * docs/reference/doxygen_to_devhelp.xsl: ditto,
+ * docs/reference/README: ditto.
+ * docs/reference/widget_hierarchy.{dia,html,png}: Delete files as
+ they belong to the documentation of the gtkmm module, not pangomm.
+
+2009-08-11 Daniel Elstner <danielk openismus com>
+
Further reduce pointless make recursion
* scripts/Makefile.am: Delete file.
diff --git a/Makefile.am b/Makefile.am
index d09d00a..8b46f37 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -28,7 +28,7 @@ doc_subdirs = docs
else
doc_subdirs =
endif
-SUBDIRS = $(src_subdirs) pango/pangomm
+SUBDIRS = $(src_subdirs) pango/pangomm $(doc_subdirs)
include $(srcdir)/MSVC_Net2005/filelist.am
include $(srcdir)/MSVC_Net2008/filelist.am
diff --git a/configure.ac b/configure.ac
index de86770..9bf7094 100644
--- a/configure.ac
+++ b/configure.ac
@@ -77,6 +77,7 @@ AC_CONFIG_FILES([Makefile
pango/src/Makefile
pango/pangomm/Makefile
docs/Makefile
+ docs/reference/Doxyfile
MSVC_Net2005/pangomm/pangomm.rc
MSVC_Net2008/pangomm/pangomm.rc])
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 4edcab3..cef088b 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,34 +1,37 @@
-## Copyright (c) 2001
-## The pangomm development team.
-
-SUBDIRS = images reference
-
-EXTRA_DIST = Makefile_web.am_fragment
-
-# pangomm_doc_DATA =
-
-include $(top_srcdir)/docs/Makefile_web.am_fragment
-
-# Post to the website.
-
-post-html-recursive:
- list='$(SUBDIRS)'; for subdir in $$list; do \
- test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) post-html); \
- done
-
-#post-html-local: index.html
-# scp $$SSH_OPT $^ $$USER $(web_host):$(web_path_docs)
-
-post-html: post-html-recursive
-
-doc-clean-recursive:
- list='$(SUBDIRS)'; for subdir in $$list; do \
- test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) doc-clean); \
- done
-
-doc-clean: doc-clean-recursive
-
-doc-rebuild: doc-clean all
-
-.PHONY: post-html post-html-local post-html-recursive doc-clean doc-clean-recursive doc-rebuild
-
+## Copyright (c) 2009 Openismus GmbH <http://www.openismus.com/>
+##
+## This file is part of pangomm.
+##
+## pangomm 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.
+##
+## pangomm 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)/pango/src/filelist.am
+include $(top_srcdir)/pango/pangomm/filelist.am
+
+pangomm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
+
+book_name = $(PANGOMM_MODULE_NAME)
+doc_input = $(addprefix $(top_srcdir)/pango/pangomm/,$(pangomm_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
+
+docimagesdir = $(libdocdir)/images
+dist_docimages_DATA = images/gtkmm_logo.gif images/top.gif
+
+include $(top_srcdir)/scripts/doc-reference.am
+
+dist_noinst_DATA += \
+ reference/pangomm_header.html_fragment \
+ reference/pangomm_footer.html_fragment
diff --git a/docs/reference/.gitignore b/docs/reference/.gitignore
new file mode 100644
index 0000000..fcf8587
--- /dev/null
+++ b/docs/reference/.gitignore
@@ -0,0 +1,5 @@
+/Doxyfile
+/doxygen.log
+/html/
+/pangomm-*.devhelp2
+/pangomm-*.tag
diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in
index 7ccd233..d628464 100644
--- a/docs/reference/Doxyfile.in
+++ b/docs/reference/Doxyfile.in
@@ -1,14 +1,15 @@
-# Doxyfile 1.4.6
+# Doxyfile 1.5.8
+# @configure_input@
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
-PROJECT_NAME = "pangomm 2.4"
-PROJECT_NUMBER =
-OUTPUT_DIRECTORY =
+DOXYFILE_ENCODING = UTF-8
+PROJECT_NAME = @PACKAGE_NAME@
+PROJECT_NUMBER = @PANGOMM_API_VERSION@
+OUTPUT_DIRECTORY = reference
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
-USE_WINDOWS_ENCODING = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \
@@ -24,13 +25,15 @@ ABBREVIATE_BRIEF = "The $name class" \
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@/pango/" \
+ "@abs_top_srcdir@/pango/" \
+STRIP_FROM_INC_PATH = "@abs_top_builddir@/pango/" \
+ "@abs_top_srcdir@/pango/"
SHORT_NAMES = NO
-JAVADOC_AUTOBRIEF = YES
+JAVADOC_AUTOBRIEF = NO
+QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP = YES
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
@@ -46,38 +49,51 @@ ALIASES = "newin2p2=\xrefitem newin2p2s \"Since pangomm 2.2\" \"N
"newin2p20=\xrefitem newin2p20s \"Since pangomm 2.20\" \"New API in pangomm 2.20\" \n"
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
#---------------------------------------------------------------------------
@@ -87,32 +103,43 @@ 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 = @GTKMM_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
-EXAMPLE_RECURSIVE = YES
-IMAGE_PATH = $(DOXYGEN_IMAGE_PATH) images/widgets
-INPUT_FILTER =
-FILTER_PATTERNS =
+EXCLUDE_PATTERNS =
+EXCLUDE_SYMBOLS = _* \
+ adaptor_trait \
+ basic_filebuf \
+ basic_streambuf \
+ binary_function \
+ char_traits \
+ internal \
+ pair \
+ unary_function
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS = *.cc \
+ *.h
+EXAMPLE_RECURSIVE = NO
+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
#---------------------------------------------------------------------------
@@ -120,27 +147,41 @@ VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
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 = @srcdir@/pangomm_header.html_fragment
-HTML_FOOTER = @srcdir@/pangomm_footer.html_fragment
-HTML_STYLESHEET =
+HTML_HEADER = "@abs_top_srcdir@/docs/reference/pangomm_header.html_fragment"
+HTML_FOOTER = "@abs_top_srcdir@/docs/reference/pangomm_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
#---------------------------------------------------------------------------
@@ -150,10 +191,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
#---------------------------------------------------------------------------
@@ -163,8 +204,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
#---------------------------------------------------------------------------
@@ -175,11 +216,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
#---------------------------------------------------------------------------
@@ -190,60 +231,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 \
- GLIBMM_VFUNCS_ENABLED \
- GLIBMM_PROPERTIES_ENABLED \
+SEARCH_INCLUDES = YES
+INCLUDE_PATH = "@abs_top_builddir@/pango" \
+ "@abs_top_srcdir@/pango"
+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 \
+ "PANGOMM_API="
+EXPAND_AS_DEFINED = PANGOMM_MAJOR_VERSION \
+ PANGOMM_MINOR_VERSION \
+ PANGOMM_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 = pangomm_doxygen_tags
-ALLEXTERNALS = YES
-EXTERNAL_GROUPS = YES
-PERL_PATH = @PERL_PATH@
+TAGFILES = @DOXYGEN_TAGFILES@
+GENERATE_TAGFILE = "reference/@PANGOMM_MODULE_NAME tag"
+ALLEXTERNALS = NO
+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 =
-MAX_DOT_GRAPH_WIDTH = 1024
-MAX_DOT_GRAPH_HEIGHT = 1024
+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]
