[fpc-pascal] fpdoc - Is there tag for function parameters?
Michael Van Canneyt
michael at freepascal.org
Tue Sep 9 10:46:46 CEST 2008
On Mon, 8 Sep 2008, Dusan Halicky wrote:
> Hi.
>
> I use fpdoc to generate documentation. I want to be function
> parameters documented also, But I affraid fpdoc doesn't support it
> yet. Here is what I have in html documentation
>
> function FooBar(
> a: integer;
> b: boolean
> ):variant;
>
> Here is what I want:
>
> function FooBar(
> a: integer; Some number desciption here
> b: boolean Second variable description
> ):variant;
>
> Is this possible? Will someone implement this? Where can I request
> this feature to be added to fpdoc? Thanks.
It exists already, since day one.
Just add an element
<element name="FooBar.a">
</element>
and
<element name="FooBar.b">
</element>
and the result can be documented with
<element name="FooBar.Result">
</element>
Makeskel generates these by default.
Michael.
More information about the fpc-pascal
mailing list