This is a tool to help document ActiveX components.
![Name: CompDoc_scr1.jpg
Views: 47
Size: 26.7 KB]()
You can import the information from the OCX or DLL file, and if you added the description of each member in the IDE, that will be added automatically as a "short description".
With that you could already generate something useful, but the purpose is to document it better by adding a "long description", specially for the properties and methods that might not be intuitive.
Anyway, when generating the final files from the 'Report' menu, it will pick the long description if available or otherwise the short one also if available.
If no descriptions are available at all, the report generated could still have some value, but only to see the structure of Controls/Classes/Properties/Methods/Events and the parameters of each member, but will have no explanation.
The long description allows some markup to reference other members (members are properties, methods and events) or the reference other Controls or Classes, also to reference Enums (not individual constants).
The markup works like this:
[c[ControlName]] refers to a control
[o[ClassName]] refers to a class, also called 'object'
[p[PropertyName]] refers to a property
[m[MethodName]] refers to a method (function or sub)
[e[EventName]] refers to an event
[[EnumName]] refers to an enum
There are some buttons that help to do that automatically.
<b>some text</b> is for bold text.
You can also put html links if you want, by placing the html code for them.
It can output HTML, RTF, PDF (through a PDF printer driver) and plain text.
The HTML pages can be one, one per object (control/class) and one per member (property/method/events). This is set in the menu Reports/Options.
You can also set some custom header/footer/style for the HTML files.
Download from GitHub.
You can import the information from the OCX or DLL file, and if you added the description of each member in the IDE, that will be added automatically as a "short description".
With that you could already generate something useful, but the purpose is to document it better by adding a "long description", specially for the properties and methods that might not be intuitive.
Anyway, when generating the final files from the 'Report' menu, it will pick the long description if available or otherwise the short one also if available.
If no descriptions are available at all, the report generated could still have some value, but only to see the structure of Controls/Classes/Properties/Methods/Events and the parameters of each member, but will have no explanation.
The long description allows some markup to reference other members (members are properties, methods and events) or the reference other Controls or Classes, also to reference Enums (not individual constants).
The markup works like this:
[c[ControlName]] refers to a control
[o[ClassName]] refers to a class, also called 'object'
[p[PropertyName]] refers to a property
[m[MethodName]] refers to a method (function or sub)
[e[EventName]] refers to an event
[[EnumName]] refers to an enum
There are some buttons that help to do that automatically.
<b>some text</b> is for bold text.
You can also put html links if you want, by placing the html code for them.
It can output HTML, RTF, PDF (through a PDF printer driver) and plain text.
The HTML pages can be one, one per object (control/class) and one per member (property/method/events). This is set in the menu Reports/Options.
You can also set some custom header/footer/style for the HTML files.
Download from GitHub.