[fpc-pascal] FPDoc - how to document a function result?

Michael Van Canneyt michael at freepascal.org
Wed Jul 12 16:05:41 CEST 2017



On Wed, 12 Jul 2017, Graeme Geldenhuys wrote:

> As the subject line says. Do I simply create a ELEMENT take with the 
> function name and ".Result"?  For example:
>
>
> <element name="MyFunction.Result">
> <short>This is the function result documentation.</short>
> </element>
>
>
> Or is there some other syntax?

This is the correct syntax.

Michael.



More information about the fpc-pascal mailing list