Changes between Version 7 and Version 8 of HeaderDoc

Timestamp:

Nov 5, 2009, 6:28:44 AM (14 years ago)

Author:

becoulet

Comment:

--

HeaderDoc

@@ -125 +125 @@
  * {{{@ref}}} and {{{@see}}}: These tags may be used when refering to an other symbol. The {{{@ref}}} tag just insert a link to the specified symbol where it appears. {{{@see}}} tags automatically generate a nice sentence add the symbol documentation end pointing to all related symbols. Do not forget to '''prepend a sharp (#) sign to macro names''' as they are in a different name space to avoid collisions. Headers and modules can be refered too with @ and + sign prefix.
  * {{{@url}}} can be used to add an internet link. You may use this to link against this wiki.
+
 Some examples:
 
@@ -138 +139 @@
 #define EFOO 1
 #define EBAR 2
+}}}
 
+{{{
 /**
   @this is really complex, you have better using the @ref works_better function instead.
@@ -154 +157 @@
 */
 #define X(a,b) do { int c = a(b); } while (0)
+}}}
+
+{{{
+/** 
+  @this defines the prototype for the generic function.
+  @see my_prototype_t
+*/
+#define MYPROTOTYPE(n) int (n)(int a, int b)
+
+/**
+  This function type does a lot of cool things which are described here.
+  @param a The first parameter
+  @param b The second parameter
+  @return the special AlmSum operator result.
+  @see #MYPROTOTYPE
+*/
+typedef MYPROTOTYPE(my_prototype_t);
 }}}