Changes between Version 2 and Version 3 of HeaderDoc
- Timestamp:
- Nov 5, 2009, 2:41:22 AM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
HeaderDoc
v2 v3 29 29 == Adding files and modules == 30 30 31 If you want to add new header files, just insert a line in your local Makefile with the '''relative''' include path:31 If you want to add new header files, just insert a line in your '''local Makefile with the relative header name''': 32 32 33 33 {{{ … … 37 37 Every documented header file must contains a documentation for the file itself. This description comment must contain a {{{@file}}} tag not to be attached to the next declaration (see example below). 38 38 39 Files, macros and symbols can be grouped in a documentation module. This is a good idea to '''create a documentation module for each MutekH library'''. This can be done by declaring the new module in the {{{doc/top.mkdoc}}} file:39 Files, macros and symbols can be grouped in a documentation module. This is a good idea to '''create a documentation module for each MutekH library'''. This can be done by declaring the new module '''in the {{{doc/top.mkdoc}}} file''': 40 40 41 41 {{{ … … 45 45 @end group 46 46 }}} 47 48 The MutekH module '''must be added in the global {{{doc/header_list.mk}}} file''' too. 47 49 48 50 Module ownership can be declared in a per declaration basis using the {{{@module}}} tag, however it's inherited by default. This means all symbols declared in a header file associated with a module are owned by the same module.
