On 30/08/2011, Hans-Peter Diettrich wrote: > > This is the purpose of makeskel. Afterwards useful information has to be > added to all items, before finally meaningful documentation can be > generated.
I personally think makeskel is a terrible idea. It generates a whole bunch of elements making it really hard to find out what is and what isn't documented. It also generates lots of unnecessary elements - obfuscating the xml and documentation more. > contained in the xml files. There exists no need for adding further > information from the source code, that's more eye candy than essential > information. I beg to differ. Seeing the signature of a method, procedure, function etc is valuable information to a developer. Not all IDE's or programming editors support "parameter hints", or some developers prefer to keep such feature disabled to speed up the editor/ide. So having such information [method signatures] available in the help is very useful. Having a inheritance hierarchy is also very valuable, which the current fpdoc XML format doesn't describe at all. This information is only available when parsing the pascal source code. -- Regards, - Graeme - _______________________________________________ fpGUI - a cross-platform Free Pascal GUI toolkit http://fpgui.sourceforge.net _______________________________________________ fpc-devel maillist - [email protected] http://lists.freepascal.org/mailman/listinfo/fpc-devel
