Re: [JEDI.NET discuss] Documentation

[Marcel B. <ma...@ze...>]

> >     I'll be cleaning up the sources of the documentation generation core and it's "test" tool cleaned up and committed later.
> Next
> > on the list is combining the xml files per assembly.
>
>     sources committed.

    they are now. I did add the files, but forgot the mandatory commit action afterwards. I didn't realize that until I committed
a bug fix in the Jedi.Docs.System namespace and noticed the line 'initial revision' in the log window.

    I've been writing some documentation (not much) to see if things were alright. It surprised me a little that for a procedure
it had generated a <returns> section, as I was sure that any method without a return time was not marked as a function. Of course,
.NET methods always have a return type, in this case the System.Void type, so that explained why procedures where marked as
function anyway.

    While checking the Jedi.Windows.Forms.Hmi.Leds documentation skeleton I noticed another nice bug: suppose you have two methods
'OnClear' and 'OnClearCompleted'. The tool would inadvertently place the OnClearCompleted method as a parameter for the OnClear
method. The (reflection) scanner will generate tags as <fully qualified method name>'@'<paramnum><paramname> and I search for
anything that starts with the qualified method name to get the parameters; of course <namespace>.<class>.OnClearComplete starts
with <namespace>.<class>.OnClear and that is not a parameter. So including the @ in the search fixed that problem.

    I've added a feature request in the NDoc forum for Object Pascal support
(http://sourceforge.net/tracker/?func=detail&aid=979662&group_id=36057&atid=416081). Let's see what they think of that.

--
Marcel Bestebroer (Team JEDI) http://delphi-jedi.org
Project JEDI Help coordinator
JEDI.NET team coordinator