I'm using Delphi to create some Automation Objects (ActiveX COM Objects), and I want to create documentation for the other developers using this COM object. However, these other developers will most likely not be Delphi developers. When I run DelphiCodeToDoc, I get CoClass documentation, property Get/Set methods get listed with the real methods, the actual class's only get two methods, and Initialize and Destroy...
SO how can I set this thing up to only document what I want it to... the IDispatch interface, accurate properties, and methods??
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
For the moment, only globals filters are available : Print Classes, Fields, Variables, etc ... or visibility filters : Public, private, published, etc ...
These options are not enough for you ?
If I understand you request, you want to choose which method/class is generated in the documentation ?
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Nope, they're not enough. When I give a COM object to a user, they don't care about the CoClass objects, the IDispatch objects, or the IDispatchDisp objects. All they will care about the specific classes, properties and methods they can use.
And unfortunately to get a decent list of properties (without Get/Set) and methods, they have to look under a completely different object than the object they would actually use.
For example, to use our object, they would instantiate it thusly:
set oObj = CreateObject("EShipper.Shipment")
However, look up the Shipment object in the generated docs, it lists nothing because the documenter lists them under the IShipmentDisp object. And that will mean nothing to them...
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I'm using Delphi to create some Automation Objects (ActiveX COM Objects), and I want to create documentation for the other developers using this COM object. However, these other developers will most likely not be Delphi developers. When I run DelphiCodeToDoc, I get CoClass documentation, property Get/Set methods get listed with the real methods, the actual class's only get two methods, and Initialize and Destroy...
SO how can I set this thing up to only document what I want it to... the IDispatch interface, accurate properties, and methods??
For the moment, only globals filters are available : Print Classes, Fields, Variables, etc ... or visibility filters : Public, private, published, etc ...
These options are not enough for you ?
If I understand you request, you want to choose which method/class is generated in the documentation ?
Nope, they're not enough. When I give a COM object to a user, they don't care about the CoClass objects, the IDispatch objects, or the IDispatchDisp objects. All they will care about the specific classes, properties and methods they can use.
And unfortunately to get a decent list of properties (without Get/Set) and methods, they have to look under a completely different object than the object they would actually use.
For example, to use our object, they would instantiate it thusly:
set oObj = CreateObject("EShipper.Shipment")
However, look up the Shipment object in the generated docs, it lists nothing because the documenter lists them under the IShipmentDisp object. And that will mean nothing to them...
So, do you have any proposition ?