#37 Including inherited class methods in documentation
PasDoc is extremely good, but one thing which would add a lot of value to PasDoc would be to include a means of documenting the functions/procedures that can be called on a particular class.
atm, PasDoc will list all functions/procedures that a particular class introduces - but there's no way of finding out what it's really capable of
e.g. If you have:
type
TClassOne = class(TComponent)
public
function MethodBase(): integer;
end;
TClassTwo = class(TClassOne)
public
function MethodSubclass(): integer;
end;
The page for TClassTwo will list "MethodSubclass", but give no indication that "MethodBase" can also be called on this subclass.
This makes working with PasDoc's output a lot more difficult than it needs to be; in order to find out what methods you can call on a particular class involves looking at the documentation for that class, then the parent class, then that parent's class...
It would be extremely useful if a layout similar to that which Delphi's help file offers would be implemented as an option, which would give an at-a-glace view of what any given class offers.
Logged In: YES
user_id=1748179
Originator: NO
(Added by otaylor_harris)
Logged In: YES
user_id=477651
Originator: NO
I'm just about adding new features to PasDoc, and also feel the need for more "inheritance" in the documentation.
An option could be added, to extend the class documentation with all inherited methods and properties. For overridden methods the general descriptions could be copied from the base class, and details about the override could be added.
The same for properties, where I want to move the related fields or methods into the description of the properties.
Eventually a cross reference could be added to base classes, indicating the classes where virtual methods are overridden.
A Delphi-style map of all accessible class members were nice, but somebody had to do the integration into the HTML files.
I think it would be nice if there was a feature to generate it, then show and hide ancestor properties, methods and descriptions directly on documentation using HTML/jQuery. However, there is a "class tree" at the top of documentation in the hierarchy section that can bring you to the ancestor class for more details.