X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=blobdiff_plain;f=codegen%2Fcodegen-stubhead.hxx;h=34493d24d025b21537a41280f2672a274561d899;hp=9ab41c0d9ab3470f4466ab6a5e7d6cc10cd26bea;hb=0a8803ccb67ea3c31cbd2405c617da3dda47f4ef;hpb=7799fec761f19ead0aeea59e7db3f4a07eb96627

diff --git a/codegen/codegen-stubhead.hxx b/codegen/codegen-stubhead.hxx
index 9ab41c0..34493d2 100644
--- 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