diff options
author | Boris Kolpackov <boris@codesynthesis.com> | 2012-06-20 11:56:54 +0200 |
---|---|---|
committer | Boris Kolpackov <boris@codesynthesis.com> | 2012-06-20 11:56:54 +0200 |
commit | c61f197baddcd2e048a106a2026c72cadc452bcd (patch) | |
tree | eb18be841b6727a1fdaa05d44a96d9935d38b31f /doc/cli.xhtml | |
parent | 07eb1add3c500ca4c53d499340bf5d524e288b39 (diff) |
Add ability to specify prologues/epilogues for generated C++ files
Also add options to specify text prologues/epilogues in addition to
files for generated man and html files.
Diffstat (limited to 'doc/cli.xhtml')
-rw-r--r-- | doc/cli.xhtml | 68 |
1 files changed, 62 insertions, 6 deletions
diff --git a/doc/cli.xhtml b/doc/cli.xhtml index bcd6959..3206c5e 100644 --- a/doc/cli.xhtml +++ b/doc/cli.xhtml @@ -156,17 +156,73 @@ <dt><code><b>--generate-html</b></code></dt> <dd>Generate documentation in the HTML format.</dd> - <dt><code><b>--man-prologue-file</b></code> <i>file</i></dt> - <dd>Insert the content of <i>file</i> at the beginning of the man page file.</dd> + <dt><code><b>--hxx-prologue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the beginning of the generated C++ header file.</dd> - <dt><code><b>--man-epilogue-file</b></code> <i>file</i></dt> - <dd>Insert the content of <i>file</i> at the end of the man page file.</dd> + <dt><code><b>--ixx-prologue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the beginning of the generated C++ inline file.</dd> + + <dt><code><b>--cxx-prologue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the beginning of the generated C++ source file.</dd> + + <dt><code><b>--man-prologue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the beginning of the generated man page file.</dd> + + <dt><code><b>--html-prologue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the beginning of the generated HTML file.</dd> + + <dt><code><b>--hxx-epilogue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the end of the generated C++ header file.</dd> + + <dt><code><b>--ixx-epilogue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the end of the generated C++ inline file.</dd> + + <dt><code><b>--cxx-epilogue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the end of the generated C++ source file.</dd> + + <dt><code><b>--man-epilogue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the end of the generated man page text.</dd> + + <dt><code><b>--html-epilogue</b></code> <i>text</i></dt> + <dd>Insert <i>text</i> at the end of the generated HTML text.</dd> + + <dt><code><b>--hxx-prologue-file</b></code> <i>file</i></dt> + <dd>Insert the content of <i>file</i> at the beginning of the generated C++ + header file.</dd> + + <dt><code><b>--ixx-prologue-file</b></code> <i>file</i></dt> + <dd>Insert the content of <i>file</i> at the beginning of the generated C++ + inline file.</dd> + + <dt><code><b>--cxx-prologue-file</b></code> <i>file</i></dt> + <dd>Insert the content of <i>file</i> at the beginning of the generated C++ + source file.</dd> + + <dt><code><b>--man-prologue-file</b></code> <i>file</i></dt> + <dd>Insert the content of <i>file</i> at the beginning of the generated man page + file.</dd> <dt><code><b>--html-prologue-file</b></code> <i>file</i></dt> - <dd>Insert the content of <i>file</i> at the beginning of the HTML file.</dd> + <dd>Insert the content of <i>file</i> at the beginning of the generated HTML + file.</dd> + + <dt><code><b>--hxx-epilogue-file</b></code> <i>file</i></dt> + <dd>Insert the content of <i>file</i> at the end of the generated C++ header + file.</dd> + + <dt><code><b>--ixx-epilogue-file</b></code> <i>file</i></dt> + <dd>Insert the content of <i>file</i> at the end of the generated C++ inline + file.</dd> + + <dt><code><b>--cxx-epilogue-file</b></code> <i>file</i></dt> + <dd>Insert the content of <i>file</i> at the end of the generated C++ source + file.</dd> + + <dt><code><b>--man-epilogue-file</b></code> <i>file</i></dt> + <dd>Insert the content of <i>file</i> at the end of the generated man page file.</dd> <dt><code><b>--html-epilogue-file</b></code> <i>file</i></dt> - <dd>Insert the content of <i>file</i> at the end of the HTML file.</dd> + <dd>Insert the content of <i>file</i> at the end of the generated HTML file.</dd> <dt><code><b>--class</b></code> <i>fq-name</i></dt> <dd>Generate the man page or HTML documentation only for the <i>fq-name</i> |