wikixc

Index Home MAE > MAE Architecture > MAE Utilities > wikixc

wikixc

This command extracts a named block of wiki text from a C/C++ file.

The command syntax is:

wikixc title cfilename [cfilename [...]]

where,

Option

Description

title

The title text to match in the source code to extract the right wikidoc documentation.

cfile

One or more files of C/C++ source code that follows the Source Code Formatting that contains a block of wikidoc text after the title.


Source Code Formatting

It scans for a line that begins with: /* wikidoc "title". All lines up to the next line that starts with */ are considered wiki content.

For example:

/* wikidoc wikixc

 * == wikixc ==

 * == Synopsis ==

 *  wikixc title cfile [cfile [...]]

 * === Summary ===

 * Extract wiki content out of C/C++ files.

 * Scan for a line that begins with: /* wikidoc "title"

 * All lines up to the next line that starts with */ are considered wiki content.

 *

 */