libt2n: (gerd) improve doxygen documentation

[libt2n] / codegen / codegen-stubhead.hxx

diff --git a/codegen/codegen-stubhead.hxx b/codegen/codegen-stubhead.hxx
index 9ab41c0..34493d2 100644 (file)
--- a/codegen/codegen-stubhead.hxx
+++ b/codegen/codegen-stubhead.hxx
@@ -12,11 +12,39 @@
 #include <command.hxx>
 
 #ifdef __GCCXML__
+// used during parsing run with gccxml
+
+/** @brief mark a function to export it via libt2n
+    @par Example
+    @code
+    LIBT2N_EXPORT std::string testfunc(std::string str)
+    {
+        // your code here
+    }
+    @endcode
+*/
 #define LIBT2N_EXPORT __attribute((gccxml("libt2n-default")))
+
+
+/** @brief tell libt2n about a default argument
+    @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"))
+    {
+        // your code here
+    }
+    @endcode
+*/
 #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
+
 #endif
 
 #endif