summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2012-06-20 11:56:54 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2012-06-20 11:56:54 +0200
commitc61f197baddcd2e048a106a2026c72cadc452bcd (patch)
treeeb18be841b6727a1fdaa05d44a96d9935d38b31f /doc
parent07eb1add3c500ca4c53d499340bf5d524e288b39 (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')
-rw-r--r--doc/cli.168
-rw-r--r--doc/cli.xhtml68
2 files changed, 124 insertions, 12 deletions
diff --git a/doc/cli.1 b/doc/cli.1
index 76bbfeb..963ab43 100644
--- a/doc/cli.1
+++ b/doc/cli.1
@@ -131,17 +131,73 @@ Generate documentation in the man page format\.
.IP "\fB--generate-html\fP"
Generate documentation in the HTML format\.
-.IP "\fB--man-prologue-file\fP \fIfile\fP"
-Insert the content of \fIfile\fP at the beginning of the man page file\.
+.IP "\fB--hxx-prologue\fP \fItext\fP"
+Insert \fItext\fP at the beginning of the generated C++ header file\.
-.IP "\fB--man-epilogue-file\fP \fIfile\fP"
-Insert the content of \fIfile\fP at the end of the man page file\.
+.IP "\fB--ixx-prologue\fP \fItext\fP"
+Insert \fItext\fP at the beginning of the generated C++ inline file\.
+
+.IP "\fB--cxx-prologue\fP \fItext\fP"
+Insert \fItext\fP at the beginning of the generated C++ source file\.
+
+.IP "\fB--man-prologue\fP \fItext\fP"
+Insert \fItext\fP at the beginning of the generated man page file\.
+
+.IP "\fB--html-prologue\fP \fItext\fP"
+Insert \fItext\fP at the beginning of the generated HTML file\.
+
+.IP "\fB--hxx-epilogue\fP \fItext\fP"
+Insert \fItext\fP at the end of the generated C++ header file\.
+
+.IP "\fB--ixx-epilogue\fP \fItext\fP"
+Insert \fItext\fP at the end of the generated C++ inline file\.
+
+.IP "\fB--cxx-epilogue\fP \fItext\fP"
+Insert \fItext\fP at the end of the generated C++ source file\.
+
+.IP "\fB--man-epilogue\fP \fItext\fP"
+Insert \fItext\fP at the end of the generated man page text\.
+
+.IP "\fB--html-epilogue\fP \fItext\fP"
+Insert \fItext\fP at the end of the generated HTML text\.
+
+.IP "\fB--hxx-prologue-file\fP \fIfile\fP"
+Insert the content of \fIfile\fP at the beginning of the generated C++
+header file\.
+
+.IP "\fB--ixx-prologue-file\fP \fIfile\fP"
+Insert the content of \fIfile\fP at the beginning of the generated C++
+inline file\.
+
+.IP "\fB--cxx-prologue-file\fP \fIfile\fP"
+Insert the content of \fIfile\fP at the beginning of the generated C++
+source file\.
+
+.IP "\fB--man-prologue-file\fP \fIfile\fP"
+Insert the content of \fIfile\fP at the beginning of the generated man page
+file\.
.IP "\fB--html-prologue-file\fP \fIfile\fP"
-Insert the content of \fIfile\fP at the beginning of the HTML file\.
+Insert the content of \fIfile\fP at the beginning of the generated HTML
+file\.
+
+.IP "\fB--hxx-epilogue-file\fP \fIfile\fP"
+Insert the content of \fIfile\fP at the end of the generated C++ header
+file\.
+
+.IP "\fB--ixx-epilogue-file\fP \fIfile\fP"
+Insert the content of \fIfile\fP at the end of the generated C++ inline
+file\.
+
+.IP "\fB--cxx-epilogue-file\fP \fIfile\fP"
+Insert the content of \fIfile\fP at the end of the generated C++ source
+file\.
+
+.IP "\fB--man-epilogue-file\fP \fIfile\fP"
+Insert the content of \fIfile\fP at the end of the generated man page file\.
.IP "\fB--html-epilogue-file\fP \fIfile\fP"
-Insert the content of \fIfile\fP at the end of the HTML file\.
+Insert the content of \fIfile\fP at the end of the generated HTML file\.
.IP "\fB--class\fP \fIfq-name\fP"
Generate the man page or HTML documentation only for the \fIfq-name\fP
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>