Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-pascal / 2008-09

fpdoc - Is there tag for function parameters?

2 messages · 2 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Dusan Halicky

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.

Reply by email

Michael Van Canneyt
to Dusan Halicky
Dusan Halicky wrote 20 lines
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.

Reply by email