aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/data/generatorrunner.1
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2020-10-28 07:51:22 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2020-10-28 09:34:35 +0000
commit2a2a0827fa54b2eeb48e0e2090dfc503492ef33e (patch)
tree4311f7ad34ff98fabcbe4c34e59a970ae4ff4bcf /sources/shiboken2/data/generatorrunner.1
parentfb1c0f204e09ba29fa3d360d72231d4ed468c1e4 (diff)
Rename shiboken2 to shiboken6
Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I4cb5ee4c8df539546014b08202a7b1e98ed3ff07 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/shiboken2/data/generatorrunner.1')
-rw-r--r--sources/shiboken2/data/generatorrunner.176
1 files changed, 0 insertions, 76 deletions
diff --git a/sources/shiboken2/data/generatorrunner.1 b/sources/shiboken2/data/generatorrunner.1
deleted file mode 100644
index f5a61f139..000000000
--- a/sources/shiboken2/data/generatorrunner.1
+++ /dev/null
@@ -1,76 +0,0 @@
-.TH GENERATORRUNNER 1 "SEPTEMBER 2009" Linux "User Manuals"
-.SH NAME
-generatorrunner - plugin-based binding source code generator
-.SH SYNOPSIS
-.B generatorrunner \-\-generator-set=<plugin name> [options] header-file typesystem-file
-.SH DESCRIPTION
-.B generatorrunner
-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 \-\-generator-set parameter. At the moment there
-are two generators available:
-
-.B qtdoc
-\- Generates Sphinx-based documentation for C++ libraries documented using
-.B qdoc
-documentation syntax, using the XML files created by the documentation tool
-.B (qdoc).
-Can be called supplying
-.B \-\-generator-set=qtdoc
-to
-.B generatorrunner
-or by calling the convenience executable
-.B docgenerator.
-
-Other plugins can be used with
-.B generatorrunner,
-provided that they follow the generator front-end specifications,
-and can be written to generate code or documentation for any target
-languague you desire. For more information about the generator front-end
-architecture and current limitations, refer to http://www.pyside.org/home-binding.
-
-.SH OPTIONS
-.SS "General options"
-.IP \-\-api-version=<version>
-Specify the supported api version used to generate the bindings.
-.IP \-\-debug-level=[sparse|medium|full]
-The amount of messages displayed.
-.IP \-\-documentation-only
-Only generates the documentation.
-.IP \-\-drop-type-entries="<TypeEntry0>[;TypeEntry1;...]"
-Semicolon separated list of type system entries (classes, namespaces, global functions and enums) to be dropped from generation.
-.IP \-\-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.
-.IP \-\-license\-file=\fI[licensefile]\fR
-Template for copyright headers of generated files.
-.IP \-\-no\-supress\-warnings
-Show all warnings.
-.IP \-\-output\-directory=\fI[dir]\fR
-The directory where the generated files will be written.
-.IP \-\-silent
-Avoid printing any messages.
-.IP \-\-typesytem\-paths=\fI<path>[:path:..]\fR
-The directories where the generator will search for the
-external typesystems referred by the main one.
-.IP \-\-version
-Displays the current version.
-Drops support for named args.
-.SS "Specific to qtdoc plugin"
-.IP \-\-documentation\-code\-snippets\-dir
-Directory used to search code snippets used by the documentation
-.IP \-\-documentation\-data\-dir
-Directory with XML files generated by documentation tool (qdoc or Doxygen)
-.IP \-\-documentation\-out\-dir
-The directory where the generated documentation files will be written
-.IP \-\-library\-source\-dir
-Directory where library source code is located
-
-.SH AUTHORS
-Lauro Moura <lauro.neto at openbossa dot org>, Bruno Araujo <bruno.araujo at openbossa dot org>, Hugo Lima <hugo.lima at openbossa dot org>
-