man synopsis (Commandes) - Source code documentation tool
NAME
synopsis - Source code documentation tool
SYNOPSIS
synopsis [options] files...
DESCRIPTION
This manual page documents briefly the synopsis command. This manual page was written for the Debian GNU/Linux distribution because the original program does not have a manual page.
synopsis is a modular source code documentation tool with support for a variety of programming languages, output formats, and comment styles.
OPTIONS
These programs follow the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below.
- -p, --parser <parser>
- Select a parser
- -Wp,<arg>[,<arg>...]
- Send args to the parser
- -Wl,<arg>[,<arg>...]
- Send args to the linker
- -f, --formatter <formatter>
- Select a formatter
- -Wf,<arg>[,<arg>...]
- Send args to the formatter
- -c, --config <filename>
- provide custom configuration through Config class in <filename>
- -Wc,<arg>[,<arg>...]
- Send args to the config module
- -I<path>
- Specify include path
- -D<macro>
- Specify macro for the parser
- -o <filename>
- Write output to <filename>
- -v, --verbose
- Print debugging info
- -V, --version
- Print version info then exit
- -h, --help
- Print this usage message and exit
- -l, --list
- List all available modules and exit
- Arguments for linker 'Linker':
- -s <scope>
- Select only the named scope.
- -m <mapper>
- Use a mapper plugin to map unresolved types new names
- -M <mapper>
- Use a std mapper (part of the Linker module) to map unresolved types new names. Currently the C++toIDL mapper is supported
- -a <access level>
- Removes all declarations with greater access level than given.
1==public only, 2==protected or public
AUTHOR
This manual page was written by Patrick Mauritz <oxygene@gmx.net>, for the Debian GNU/Linux system (but may be used by others).