Changes between Version 12 and Version 13 of HeaderDoc


Ignore:
Timestamp:
Nov 29, 2009, 1:22:49 AM (10 years ago)
Author:
nipo
Comment:

Links to API reference from trac

Legend:

Unmodified
Added
Removed
Modified
  • HeaderDoc

    v12 v13  
     1
     2[[PageOutline]]
    13
    24This document explains how to write correct documentation in header source files for the [http://www.mutekh.org/www/mutekh_api/ MutekH API reference manual].
     
    194196}}}
    195197
     198= Linking from Trac to the API Reference Manual =
     199
     200Using the InterMapTxt feature of Trac, you can provide links from anywhere in the Trac site to the API reference manual using links looking like:
     201
     202 `api:`''type''`:`''name'' where::
     203  * ''type'' can be `macro`, `function`, `enum`, `struct`, or `field`
     204  * ''name'' is the name (without the `#` for macros, and like `struct_name.field_name` for ''field''s)
     205
     206Example:
     207
     208{{{
     209 * [api:function:pthread_create link to pthread_create]
     210 * [api:macro:CONFIG_CPU_MAXCOUNT fancy text]
     211 * [api:struct:context_s CPU context structure]
     212 * [api:struct:fdt_walker_s.on_node_entry field on_node_entry of fdt_walker_s]
     213}}}
     214
     215 Yields::
     216  * [api:function:pthread_create link to pthread_create]
     217  * [api:macro:CONFIG_CPU_MAXCOUNT fancy text]
     218  * [api:struct:context_s CPU context structure]
     219  * [api:field:fdt_walker_s.on_node_entry field on_node_entry of fdt_walker_s]