summaryrefslogtreecommitdiff
path: root/src/components/policy/policy_external/doc/doxygen/tools/InterfaceGenerator/How To Use.txt
blob: e7b14b0da18a838ab128239e791b7042b931f4f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/*! \page tools_interfacegenerator_usage How to use InterfaceGenerator

To run InterfaceGenerator the Python 3.5+ interpreter should be installed. As input InterfaceGenerator requires full path to the source XML file, namespace to generate result code in, full path to the output directory where result source code C++ will be created and optionally explicit specification of parser type.

Example1 (Run Generator.py to display help):

<pre>
$ python Generator.py -h

usage: Generator.py [-h] --parser-type {alrpcv1,alrpcv2}
                    source-xml namespace output-dir

SmartSchema interface generator

positional arguments:
  source-xml
  namespace
  output-dir

optional arguments:
  -h, --help            show this help message and exit
  --parser-type {alrpcv1,alrpcv2}
</pre>

Example2 (Run Generator.py to generate some code)

<pre>
python Generator.py /home/user1/xml/alrpc1.xml App::Gen:: /home/user1/gen --parser-type=alrpcv2
</pre>

*/