[mm-common] Document the shared Doxygen style sheet



commit 101904cdd7006f92d8897101a7c224745460c575
Author: Daniel Elstner <danielk openismus com>
Date:   Mon Sep 21 14:39:03 2009 +0200

    Document the shared Doxygen style sheet
    
    * README: In the Documentation utilities section, expand the text and
    add a paragraph documenting the purpose of the util/doxygen.css file.

 README |   23 ++++++++++++++---------
 1 files changed, 14 insertions(+), 9 deletions(-)
---
diff --git a/README b/README
index af160de..070405e 100644
--- a/README
+++ b/README
@@ -143,15 +143,16 @@ build/dist-changelog.am:
 Documentation utilities
 -----------------------
 
-These are two Perl scripts and one XSL transformation which assist with
-the task of generating and installing the Doxygen reference documentation.
-At least doc-install.pl is also required for tarball builds.  To avoid
-copying these files into all binding modules, they are also distributed
-and installed with the glibmm module.  Those binding modules which cannot
-depend on glibmm must call MM_CONFIG_DOCTOOL_DIR([...]) in configure.ac
-to indicate to mm-common-prepare that it should copy the documentation
-utilities into the project's source tree.  Otherwise the files installed
-with glibmm will be used automatically.
+These are two Perl scripts, a style sheet, and one XSL transformation
+which assist with the task of generating and installing the Doxygen
+reference documentation.  At least doc-install.pl is also required for
+tarball builds.
+To avoid copying these files into all binding modules, they are also
+distributed and installed with the glibmm module.  Those binding modules
+which cannot depend on glibmm must call MM_CONFIG_DOCTOOL_DIR([...]) in
+configure.ac to indicate to mm-common-prepare that it should copy the
+documentation utilities into the project's source tree.  Otherwise the
+files installed with glibmm will be used automatically.
 
 util/doc-postprocess.pl:
   A simple script to post-process the HTML files generated by Doxygen.
@@ -173,6 +174,10 @@ util/doc-install.pl:
   as well, and will happily pass through unrecognized files without any
   alterations.
 
+util/doxygen.css:
+  A Cascading Style Sheet to unify the appearance of the HTML reference
+  documentation generated by Doxygen for each C++ binding module.
+
 util/tagfile-to-devhelp2.xsl:
   An XSLT script to generate a Devhelp2 book for the Doxygen reference
   documentation.  The generated Doxygen tag file serves as the input of



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]