aboutsummaryrefslogtreecommitdiffstats
path: root/data/generatorrunner.1
diff options
context:
space:
mode:
Diffstat (limited to 'data/generatorrunner.1')
-rw-r--r--data/generatorrunner.112
1 files changed, 7 insertions, 5 deletions
diff --git a/data/generatorrunner.1 b/data/generatorrunner.1
index 60749d951..072d373a1 100644
--- a/data/generatorrunner.1
+++ b/data/generatorrunner.1
@@ -9,17 +9,17 @@ generatorrunner - plugin-based binding source code generator
is a utility that uses the information taken from APIExtractor
related to the provided C++ headers and typesystem files and execute
generators using this information. Generators are plugins and you need
-to specify one using the \-\-generatorSet parameter. At the moment there
+to specify one using the \-\-generatorSet parameter. At the moment there
are two generators available:
.B qtdoc
-\- Generates Sphinx-based documentation for C++ libraries documented using
-.B qdoc3
-documentation syntax, using the XML files created by the documentation tool
+\- Generates Sphinx-based documentation for C++ libraries documented using
+.B qdoc3
+documentation syntax, using the XML files created by the documentation tool
.B (qdoc3).
Can be called supplying
.B \-\-generatorSet=qtdoc
-to
+to
.B generatorrunner
or by calling the convenience executable
.B docgenerator.
@@ -40,6 +40,8 @@ Only generates the documentation.
.TP
.BI \-\-help \fR,\fP \-h \fR,\fP -?
Prints the usage message.
+.IP \-\-project-file=<file>
+Text file containing a description of the binding project. Replaces and overrides command line arguments.
.IP \-\-include\-paths=\fI<path>[:path:..]\fR
The directories where the generator will search for the
headers. Works like gcc's \-I flag.