Ticket #21 (closed enhancement: fixed)
Pointing to code generators
| Reported by: | michelpons | Owned by: | jasper |
|---|---|---|---|
| Priority: | minor | Milestone: | Phase II |
| Component: | COBIA SDK Reference | Version: | 1.0 |
| Keywords: | Cc: |
Description
In the section on interfaces, wrappers and adapters of the main page of the COBIA Reference, at the very end, there is the following sentence "To generate all the functions and derive from the proper base class to implement an interface, the COBIA code generators can be used. E.g. use COBIA_CodeGen with the -c, -i and -A options." The code generator is not part of the reference. Is there a way to point to some place on the machine where the code generator stands? The COBIA SDK installer does not give the option to install only COBIA Reference so everything present in the COBIA SDK installer ends up to be installed, among those the COBIA code generator. So is there a link somehow that can be inserted to point to the code generator executable? Otherwise this reference does not make much sense as it is.
Change History
comment:2 Changed 4 years ago by jasper
The code generator headers (interfaces, wrappers, adapters) are not currently part of the client header files (as they are required to author wizards etc.; not required for PMC or PME generation). Same goes for IDL interfaces, wrappers and adapters. Should they be part of the SDK? Seems to make sense.
In this case the corresponding documentation should also be part of the SDK.
Then it would make sense to have documentation on COBIA_codegen.exe to live in one of those header files as a separate page.
comment:3 Changed 4 years ago by anonymous
The point with code generators is that they are there to be used rather than be understood. At least for most developers who are not going to develop an application based on the code generators. Most developers will develop applications using the code generators. It is why so far the code generators as source are kept to CO-LaN members.
Pointing to COBIA_codegen.exe without mentioning where it lives does not seem right. There is no program entry that leads to the code generator. Would it make sense to have one opening a command windows from the start menu in the folder where the code generators are? Would such an entry be a kind of permanent reference?
comment:4 Changed 4 years ago by jasper
My vote would be to put the 'public' code generation stuff (the interfaces) in the SDK.
comment:6 Changed 3 years ago by jasper
Running COBIA_CodeGen.exe gives minimal documentation on its use already.
We could add a developers command prompt, which is a normal command prompt that has the code generation binary folder in the path, as a short cut link from the start menu. We could add a comment in the box that shows how to get the help for both cobiaregister.exe and COBIA_CodeGen.exe.
Note that to do so, a batch file needs to be added to the distro.
We should create documentation on the code generator and link to that.