[mm-common] Fine-tune skeleton Doxygen configuration



commit a9d41925ad4b206b1d8eeea1e88fe5135fc748a4
Author: Daniel Elstner <daniel kitta gmail com>
Date:   Mon Dec 28 04:06:00 2009 +0100

    Fine-tune skeleton Doxygen configuration
    
    * docs/reference/Doxyfile.in (EXTRACT_ALL): Disable, so that only
    documented classes and functions will appear in the documentation.
    (EXTRACT_PRIVATE): Enable.  It is perfectly fine to have private
    virtual methods, which are of course nonetheless part of the API.
    Use the Doxygen @internal command to hide members if necessary.
    (SHOW_INCLUDE_FILES): Enable.  The displayed filename can be adjusted
    with the @headerfile command if required.
    (SHOW_USED_FILES): Disable.
    (WARN_NO_PARAMDOC): Enable.
    (PREDEFINED): Define G_GNUC_INTERNAL to the empty expansion.
    (CLASS_DIAGRAMS): Enable.  Contrary to what the Doxygen documentation
    says, no dot class inheritance graphs will be generated if both
    CLASS_DIAGRAMS and COLLABORATION_GRAPH are set to NO.
    (COLLABORATION_GRAPH), (GROUP_GRAPHS): Turn off additional graphs to
    reduce the noise.

 skeletonmm/doc/reference/Doxyfile.in |   17 +++++++++--------
 1 files changed, 9 insertions(+), 8 deletions(-)
---
diff --git a/skeletonmm/doc/reference/Doxyfile.in b/skeletonmm/doc/reference/Doxyfile.in
index c3d5f07..baa984c 100644
--- a/skeletonmm/doc/reference/Doxyfile.in
+++ b/skeletonmm/doc/reference/Doxyfile.in
@@ -48,8 +48,8 @@ SYMBOL_CACHE_SIZE      = 0
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
-EXTRACT_ALL            = YES
-EXTRACT_PRIVATE        = NO
+EXTRACT_ALL            = NO
+EXTRACT_PRIVATE        = YES
 EXTRACT_STATIC         = NO
 EXTRACT_LOCAL_CLASSES  = NO
 EXTRACT_LOCAL_METHODS  = NO
@@ -61,7 +61,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
@@ -74,7 +74,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
@@ -87,7 +87,7 @@ QUIET                  = NO
 WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
-WARN_NO_PARAMDOC       = NO
+WARN_NO_PARAMDOC       = YES
 WARN_FORMAT            = "$file:$line: $text"
 WARN_LOGFILE           = reference/doxygen.log
 #---------------------------------------------------------------------------
@@ -234,6 +234,7 @@ INCLUDE_FILE_PATTERNS  = *.h
 PREDEFINED             = __cplusplus \
                          DOXYGEN_SHOULD_SKIP_THIS \
                          "G_GNUC_CONST=" \
+                         "G_GNUC_INTERNAL=" \
                          "SKELETONMM_API=" \
                          GLIBMM_VFUNCS_ENABLED \
                          GLIBMM_PROPERTIES_ENABLED \
@@ -254,7 +255,7 @@ 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
@@ -262,8 +263,8 @@ DOT_FONTNAME           = FreeSans
 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
 INCLUDE_GRAPH          = NO



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