createDoc/readme_createDoc.txt at main · Synergex/createDoc · GitHub

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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
README.TXT for CREATEDOC.ZIP

Description
-----------

This application is intended to help generate {xfMethod} & {xfParam} attributes
from existing source files, or from the XML documented created by GENXML.
It can also generate documentation comments.


Starting with Synergy source file
---------------------------------

dbr createDoc -s <dblFile> <elbName> -i <interface> -x <xmlFile> -o <outFile>

This will read through the <dblFile> and will create the <xmlFile> in GENXML
format.  The <elbName> and <interface> are used to populate data in <xmlFile>.

Once the <xmlFile> has been created, the program analyzes the <xmlFile> and
creates the <outFile> as a dummy Synergy source file. Note, the <xmlFile>
created is not deleted, so that it can be used as an import file for importing
into the Synergy Method Catalog (SMC).


Starting with populated SMC
---------------------------

Run MDU and export the methods to <xmlFile>

dbr createDoc -x <xmlFile> -o <outFile> [-i <interface>]

This will read through the <xmlFile> and create <outFile> as a dummy Synergy
source file.  If <interface> is specified, only methods in the selected
interface are processed.  If <interface> is not specified, all interfaces /
methods are processed.

Once the output file is generated, you can cut/paste the resulting {xf}
attributes and/or documentation comments into your application source code.


Known Issues
------------

If you wish to use the <xmlFile> generated by createDoc as an import file
for SMC, you must ensure that all parameters are correctly defined in the
Synergy source file, including parameter size.

If you use .INCLUDE files as parameters, createDoc will treat the entire
.include line as the parameter name to be used in the <xmlFile>, and will
interrogate the contents of the .include file for the name of the GROUP.
This will result in an XML file that cannot be imported into SMC.  If you
want to use group parameters, they must in included from Repository.

It's possible to use the same Synergy method as the execution method for
more than one xfNetLink method (e.g. with/without data table options). In
this scenario, you will get more than one version of the named Synergy
routine in the output, each version will be attributed correctly.


Submission details
------------------

Author:                 William Hawkins
Company:                Synergex
Email:                  William.Hawkins@Synergex.com
Date:                   3rd June 2011
Minimum version:        Synergy/DE 9.5.1
Platforms:              Any
Compiler command:       DBL createDoc.dbl createXmlFromSrc.dbl createDocFromXml.dbl decode_src_utils.dbl
Link command            DBLINK createDoc.dbo DBLDIR:synxml.elb RPSLIB:ddlib.elb
Files:                  createDoc.dbl createXmlFromSrc.dbl createDocFromXml.dbl decode_src_utils.dbl genxml_tokens.def
Logicals Used:          INC:

Modification history
--------------------

1.1     22nd June 2011
Now shows REQ & IN as parameter modifiers in the output when modifiers are
not specified. Also preserves case (upper/lower) of Repository include names.

1.2     27th June 2011
Now copes with a Repository include being the first record in the data division.