[glibmm] Fine-tune Doxygen configuration to improve output



commit c405a82133cf464bbb190c67cc07958bc0f7228e
Author: Daniel Elstner <daniel kitta gmail com>
Date:   Wed Jan 6 00:45:02 2010 +0100

    Fine-tune Doxygen configuration to improve output
    
    * docs/reference/Doxyfile.in (SHOW_INCLUDE_FILES): Enable option, as
    it looks better than SHOW_USED_FILES and can be adjusted by means of
    the @headerfile command.
    (SHOW_USED_FILES): Disable.
    (ALPHABETICAL_INDEX): Enable alphabetical class index.
    (PREDEFINED): Predefine G_GNUC_INTERNAL in anticipation of explicit
    symbol visibility attributes.
    (CLASS_DIAGRAMS): Enable to get class inheritance graphs without any
    of the other graph options.
    (DOT_FONTNAME): Change to Sans to avoid the bad hinting for FreeSans
    at least on my system, which resulted in blurry graph labels.
    (COLLABORATION_GRAPH), (GROUP_GRAPHS), (TEMPLATE_RELATIONS): Disable
    additional graphs to reduce the noise.

 ChangeLog                  |   18 ++++++++++++++++++
 docs/reference/Doxyfile.in |   17 +++++++++--------
 2 files changed, 27 insertions(+), 8 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index f981961..1f7ed41 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,21 @@
+2010-01-05  Daniel Elstner  <daniel kitta gmail com>
+
+	Fine-tune Doxygen configuration to improve output
+
+	* docs/reference/Doxyfile.in (SHOW_INCLUDE_FILES): Enable option, as
+	it looks better than SHOW_USED_FILES and can be adjusted by means of
+	the @headerfile command.
+	(SHOW_USED_FILES): Disable.
+	(ALPHABETICAL_INDEX): Enable alphabetical class index.
+	(PREDEFINED): Predefine G_GNUC_INTERNAL in anticipation of explicit
+	symbol visibility attributes.
+	(CLASS_DIAGRAMS): Enable to get class inheritance graphs without any
+	of the other graph options.
+	(DOT_FONTNAME): Change to Sans to avoid the bad hinting for FreeSans
+	at least on my system, which resulted in blurry graph labels.
+	(COLLABORATION_GRAPH), (GROUP_GRAPHS), (TEMPLATE_RELATIONS): Disable
+	additional graphs to reduce the noise.
+
 2009-12-16  Armin Burgmeier  <armin arbur net>
 
 	* gio/giomm.h: Don't include files on Windows that are not available
diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in
index 81c1b43..4641bb7 100644
--- a/docs/reference/Doxyfile.in
+++ b/docs/reference/Doxyfile.in
@@ -65,7 +65,7 @@ HIDE_IN_BODY_DOCS      = YES
 INTERNAL_DOCS          = NO
 CASE_SENSE_NAMES       = YES
 HIDE_SCOPE_NAMES       = NO
-SHOW_INCLUDE_FILES     = NO
+SHOW_INCLUDE_FILES     = YES
 INLINE_INFO            = YES
 SORT_MEMBER_DOCS       = YES
 SORT_BRIEF_DOCS        = NO
@@ -78,7 +78,7 @@ GENERATE_BUGLIST       = NO
 GENERATE_DEPRECATEDLIST= YES
 ENABLED_SECTIONS       =
 MAX_INITIALIZER_LINES  = 2
-SHOW_USED_FILES        = YES
+SHOW_USED_FILES        = NO
 SHOW_DIRECTORIES       = NO
 SHOW_FILES             = NO
 SHOW_NAMESPACES        = YES
@@ -137,7 +137,7 @@ VERBATIM_HEADERS       = NO
 #---------------------------------------------------------------------------
 # configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
-ALPHABETICAL_INDEX     = NO
+ALPHABETICAL_INDEX     = YES
 COLS_IN_ALPHA_INDEX    = 5
 IGNORE_PREFIX          =
 #---------------------------------------------------------------------------
@@ -242,6 +242,7 @@ INCLUDE_FILE_PATTERNS  = *.h
 PREDEFINED             = __cplusplus \
                          DOXYGEN_SHOULD_SKIP_THIS \
                          "G_GNUC_CONST=" \
+                         "G_GNUC_INTERNAL=" \
                          "G_GNUC_NORETURN=" \
                          "G_GNUC_NULL_TERMINATED=" \
                          "G_GNUC_PURE=" \
@@ -270,18 +271,18 @@ PERL_PATH              = @PERL@
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
-CLASS_DIAGRAMS         = NO
+CLASS_DIAGRAMS         = YES
 MSCGEN_PATH            =
 HIDE_UNDOC_RELATIONS   = NO
 HAVE_DOT               = YES
-DOT_FONTNAME           = FreeSans
+DOT_FONTNAME           = Sans
 DOT_FONTSIZE           = 10
 DOT_FONTPATH           =
 CLASS_GRAPH            = YES
-COLLABORATION_GRAPH    = YES
-GROUP_GRAPHS           = YES
+COLLABORATION_GRAPH    = NO
+GROUP_GRAPHS           = NO
 UML_LOOK               = NO
-TEMPLATE_RELATIONS     = YES
+TEMPLATE_RELATIONS     = NO
 INCLUDE_GRAPH          = NO
 INCLUDED_BY_GRAPH      = NO
 CALL_GRAPH             = NO



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