| Re: Inheriting Properties (or something similar) in IDLDOC [message #83133 is a reply to message #83090] |
Wed, 06 February 2013 06:42   |
tom.grydeland
Messages: 51
Registered: September 2012
|
Member |
|
|
On Sunday, February 3, 2013 10:30:00 PM UTC, Mike Galloy wrote:
> OK, showing inherited methods is in the current master branch of IDLdoc.
> See the output at:
> http://docs.idldev.com/mglib/
> In particular, see a subclass:
> http://docs.idldev.com/mglib/collection/mgcoarraylist__defin e.html
> This will be in the next release of IDLdoc. Let me know if you see any
> problems.
Basically, this looks good. I have a couple of issues:
1) Shadowed (or overridden) methods are listed. I would much prefer they weren't. Showing only the method that will be called makes browsing documentation much easier. In the currently produced documentation, you have to look through the complete method list to see which one will be called. (And are superclasses listed in inheritance order or not?) Granted, there are tasks where knowing about the shadowed methods of superclasses is useful, but I would prefer a different approach. For instance, the documentation for each method could have a small box (beneath the signature, before documentation) stating "Overrides definition from superclass idl_object", with link to the documentation for the superclass method (when applicable).
2) In the top-level listing (frames view), I followed "subclasses" links from idl_object__define to mg_graph_democlass__define. From this window, links to inherited methods did not work. (HREF=" http://docs.idldev.com/mglib/vis/objects/idl_object__define. html#idl_object::init#idl_object::init")
> Mike
Thanks,
--T
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
