From c61f197baddcd2e048a106a2026c72cadc452bcd Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Wed, 20 Jun 2012 11:56:54 +0200 Subject: 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. --- doc/cli.1 | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++------ doc/cli.xhtml | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++------ 2 files changed, 124 insertions(+), 12 deletions(-) (limited to 'doc') 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 @@
--generate-html
Generate documentation in the HTML format.
-
--man-prologue-file file
-
Insert the content of file at the beginning of the man page file.
+
--hxx-prologue text
+
Insert text at the beginning of the generated C++ header file.
-
--man-epilogue-file file
-
Insert the content of file at the end of the man page file.
+
--ixx-prologue text
+
Insert text at the beginning of the generated C++ inline file.
+ +
--cxx-prologue text
+
Insert text at the beginning of the generated C++ source file.
+ +
--man-prologue text
+
Insert text at the beginning of the generated man page file.
+ +
--html-prologue text
+
Insert text at the beginning of the generated HTML file.
+ +
--hxx-epilogue text
+
Insert text at the end of the generated C++ header file.
+ +
--ixx-epilogue text
+
Insert text at the end of the generated C++ inline file.
+ +
--cxx-epilogue text
+
Insert text at the end of the generated C++ source file.
+ +
--man-epilogue text
+
Insert text at the end of the generated man page text.
+ +
--html-epilogue text
+
Insert text at the end of the generated HTML text.
+ +
--hxx-prologue-file file
+
Insert the content of file at the beginning of the generated C++ + header file.
+ +
--ixx-prologue-file file
+
Insert the content of file at the beginning of the generated C++ + inline file.
+ +
--cxx-prologue-file file
+
Insert the content of file at the beginning of the generated C++ + source file.
+ +
--man-prologue-file file
+
Insert the content of file at the beginning of the generated man page + file.
--html-prologue-file file
-
Insert the content of file at the beginning of the HTML file.
+
Insert the content of file at the beginning of the generated HTML + file.
+ +
--hxx-epilogue-file file
+
Insert the content of file at the end of the generated C++ header + file.
+ +
--ixx-epilogue-file file
+
Insert the content of file at the end of the generated C++ inline + file.
+ +
--cxx-epilogue-file file
+
Insert the content of file at the end of the generated C++ source + file.
+ +
--man-epilogue-file file
+
Insert the content of file at the end of the generated man page file.
--html-epilogue-file file
-
Insert the content of file at the end of the HTML file.
+
Insert the content of file at the end of the generated HTML file.
--class fq-name
Generate the man page or HTML documentation only for the fq-name -- cgit v1.1