1GENERATORRUNNER(1)               User Manuals               GENERATORRUNNER(1)
2
3
4

NAME

6       generatorrunner - plugin-based binding source code generator
7

SYNOPSIS

9       generatorrunner  --generator-set=<plugin  name>  [options]  header-file
10       typesystem-file
11

DESCRIPTION

13       generatorrunner is a utility  that  uses  the  information  taken  from
14       APIExtractor  related  to the provided C++ headers and typesystem files
15       and execute generators using this information. Generators  are  plugins
16       and you need to specify one using the --generator-set parameter. At the
17       moment there are two generators available:
18
19       qtdoc - Generates Sphinx-based documentation for  C++  libraries  docu‐
20       mented using qdoc3 documentation syntax, using the XML files created by
21       the documentation tool (qdoc3).  Can be called  supplying  --generator-
22       set=qtdoc  to  generatorrunner or by calling the convenience executable
23       docgenerator.
24
25       Other plugins can be used with generatorrunner, provided that they fol‐
26       low  the generator front-end specifications, and can be written to gen‐
27       erate code or documentation for any target languague  you  desire.  For
28       more information about the generator front-end architecture and current
29       limitations, refer to http://www.pyside.org/home-binding.
30
31

OPTIONS

33   General options
34       --api-version=<version>
35              Specify the supported api version used to generate the bindings.
36
37       --debug-level=[sparse|medium|full]
38              The amount of messages displayed.
39
40       --documentation-only
41              Only generates the documentation.
42
43       --drop-type-entries="<TypeEntry0>[;TypeEntry1;...]"
44              Semicolon separated list of type system entries (classes, names‐
45              paces,  global  functions  and enums) to be dropped from genera‐
46              tion.
47
48       --help Prints the usage message.
49
50       --project-file=<file>
51              Text file containing  a  description  of  the  binding  project.
52              Replaces and overrides command line arguments.
53
54       --include-paths=<path>[:path:..]
55              The directories where the generator will search for the headers.
56              Works like gcc's -I flag.
57
58       --license-file=[licensefile]
59              Template for copyright headers of generated files.
60
61       --no-supress-warnings
62              Show all warnings.
63
64       --output-directory=[dir]
65              The directory where the generated files will be written.
66
67       --silent
68              Avoid printing any messages.
69
70       --typesytem-paths=<path>[:path:..]
71              The directories where the generator will search for the external
72              typesystems referred by the main one.
73
74       --version
75              Displays the current version.  Drops support for named args.
76
77   Specific to qtdoc plugin
78       --documentation-code-snippets-dir
79              Directory used to search code snippets used by the documentation
80
81       --documentation-data-dir
82              Directory  with XML files generated by documentation tool (qdoc3
83              or Doxygen)
84
85       --documentation-out-dir
86              The directory where the generated documentation  files  will  be
87              written
88
89       --library-source-dir
90              Directory where library source code is located
91
92

AUTHORS

94       Lauro   Moura   <lauro.neto   at   openbossa  dot  org>,  Bruno  Araujo
95       <bruno.araujo at openbossa dot org>, Hugo Lima <hugo.lima at  openbossa
96       dot org>
97
98
99
100
101Linux                           SEPTEMBER 2009              GENERATORRUNNER(1)