[fpc-devel] fpdoc enhancement

Graeme Geldenhuys graemeg.lists at gmail.com
Wed Aug 30 13:59:45 CEST 2006

On 8/30/06, Michael Van Canneyt <michael at freepascal.org> wrote:
> Try the printshort tag:
>   <descr><printshort id="TCustomListView.Change">. This procedure makes sure the OnChange() event is
>    called if the user assigned a method to this event.</descr>

You guys also think of everything!  :-)
One minor typo in your example.  It needs the closing "/".

<printshort id="TCustomListView.Change"/>

> The lazdoc editor could be enhanced to have an option which includes this tag by default
> if the description node is empty. I could even add this option to the makeskel program.

I like these ideas.... Should save on a lot of typing and potential typos.

> But it's definitely not common practice in the RTL or FCL docs.
> RTL/FCL practice is to start the description with the name of
> the element.

I stand corrected!  :-)

  - Graeme -

More information about the fpc-devel mailing list