From: Gerd v. Egidy <gerd.von.egidy@intra2net.com>
Date: Wed, 23 Jul 2008 08:50:13 +0000 (+0000)
Subject: libt2n: (gerd) improve doxygen documentation
X-Git-Tag: v0.4~22
X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=commitdiff_plain;h=57ed25354d81e2820c1c078766b350d2d098e222

libt2n: (gerd) improve doxygen documentation
---

diff --git a/codegen/codegen-stubhead.hxx b/codegen/codegen-stubhead.hxx
index 34493d2..171d399 100644
--- a/codegen/codegen-stubhead.hxx
+++ b/codegen/codegen-stubhead.hxx
@@ -17,7 +17,7 @@
 /** @brief mark a function to export it via libt2n
     @par Example
     @code
-    LIBT2N_EXPORT std::string testfunc(std::string str)
+    LIBT2N_EXPORT std::string testfunc(const std::string &str)
     {
         // your code here
     }
@@ -27,8 +27,8 @@
 
 
 /** @brief tell libt2n about a default argument
-    @param _type type of the default argument
-    @param _value default value
+    @param type type of the default argument
+    @param value default value
     @par Example
     @code
     LIBT2N_EXPORT std::string testfunc(LIBT2N_DEFAULT_ARG(const std::string str&,"hello world"))
@@ -36,14 +36,16 @@
         // your code here
     }
     @endcode
+    @remarks Codegen gets default arguments via this define (gccxml-attribute) because gccxml
+             does not correctly output them (e.g. the namespace is ambiguous)
 */
-#define LIBT2N_DEFAULT_ARG(_type,_value) __attribute((gccxml("libt2n-default-arg",#_value))) _type = _value
+#define LIBT2N_DEFAULT_ARG(type,value) __attribute((gccxml("libt2n-default-arg",#value))) type = value
 
 #else
 // used during regular compile
 
 #define LIBT2N_EXPORT
-#define LIBT2N_DEFAULT_ARG(_type,_value) _type = _value
+#define LIBT2N_DEFAULT_ARG(type,value) type = value
 
 #endif
 
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 52e6c4e..e16f358 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -53,17 +53,7 @@ CREATE_SUBDIRS         = NO
 
 OUTPUT_LANGUAGE        = English
 
-# This tag can be used to specify the encoding used in the generated output. 
-# The encoding is not always determined by the language that is chosen, 
-# but also whether or not the output is meant for Windows or non-Windows users. 
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
-# forces the Windows encoding (this is the default for the Windows binary), 
-# whereas setting the tag to NO uses a Unix-style encoding (the default for 
-# all platforms other than Windows).
-
-USE_WINDOWS_ENCODING   = NO
-
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
 # include brief member descriptions after the members that are listed in 
 # the file and class documentation (similar to JavaDoc). 
 # Set to NO to disable this.
@@ -500,7 +490,7 @@ EXCLUDE_PATTERNS       =
 # directories that contain example code fragments that are included (see 
 # the \include command).
 
-EXAMPLE_PATH           = @top_srcdir@/examples-codegen/example1/ @top_srcdir@/examples-codegen/example1-client/
+EXAMPLE_PATH           = @top_srcdir@/examples-codegen
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -514,7 +504,7 @@ EXAMPLE_PATTERNS       =
 # commands irrespective of the value of the RECURSIVE tag. 
 # Possible values are YES and NO. If left blank NO is used.
 
-EXAMPLE_RECURSIVE      = NO
+EXAMPLE_RECURSIVE      = YES
 
 # The IMAGE_PATH tag can be used to specify one or more files or 
 # directories that contain image that are included in the documentation (see 
@@ -1187,23 +1177,7 @@ DOT_PATH               =
 
 DOTFILE_DIRS           = 
 
-# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
-# this value, doxygen will try to truncate the graph, so that it fits within 
-# the specified constraint. Beware that most browsers cannot cope with very 
-# large images.
-
-MAX_DOT_GRAPH_WIDTH    = 1024
-
-# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
-# this value, doxygen will try to truncate the graph, so that it fits within 
-# the specified constraint. Beware that most browsers cannot cope with very 
-# large images.
-
-MAX_DOT_GRAPH_HEIGHT   = 1024
-
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
 # from the root by following a path via at most 3 edges will be shown. Nodes 
 # that lay further from the root node will be omitted. Note that setting this