Changes between Version 12 and Version 13 of HeaderDoc

Timestamp:

Nov 29, 2009, 1:22:49 AM (15 years ago)

Author:

Nicolas Pouillon

Comment:

Links to API reference from trac

HeaderDoc

@@ +1 @@
+
+[[PageOutline]]
 
 This document explains how to write correct documentation in header source files for the [http://www.mutekh.org/www/mutekh_api/ MutekH API reference manual].
@@ -194 +196 @@
 }}}
 
+= Linking from Trac to the API Reference Manual =
+
+Using the InterMapTxt feature of Trac, you can provide links from anywhere in the Trac site to the API reference manual using links looking like:
+
+ `api:`''type''`:`''name'' where::
+  * ''type'' can be `macro`, `function`, `enum`, `struct`, or `field`
+  * ''name'' is the name (without the `#` for macros, and like `struct_name.field_name` for ''field''s)
+
+Example:
+
+{{{
+ * [api:function:pthread_create link to pthread_create]
+ * [api:macro:CONFIG_CPU_MAXCOUNT fancy text]
+ * [api:struct:context_s CPU context structure]
+ * [api:struct:fdt_walker_s.on_node_entry field on_node_entry of fdt_walker_s]
+}}}
+
+ Yields::
+  * [api:function:pthread_create link to pthread_create]
+  * [api:macro:CONFIG_CPU_MAXCOUNT fancy text]
+  * [api:struct:context_s CPU context structure]
+  * [api:field:fdt_walker_s.on_node_entry field on_node_entry of fdt_walker_s]