Sign in Join

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

Mailing lists / fpc-pascal / 2011-02

fpdoc (fpc 2.4.2)

3 messages · 2 people ·

Reply by email Subscribe to this list Your subscription

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

Mark Morgan Lloyd

I'm currently working on a translator from SNMP MIB files to Pascal, and on a whim decided to see how well they documented. Two questions if I may.

i) fpdoc appears to lose the fact that a procedure or function is prefixed "class".

ii) I've got comments associated with class procedures/functions that are showing up in Lazarus, but not in fpdoc. What's the preferred format for these?

Mark Morgan Lloyd markMLl .AT. telemetry.co .DOT. uk [Opinions above are the author's, not those of his employers or colleagues]
Michael Van Canneyt
to Mark Morgan Lloyd
Mark Morgan Lloyd wrote 5 lines
I'm currently working on a translator from SNMP MIB files to Pascal, and on a whim decided to see how well they documented. Two questions if I may. i) fpdoc appears to lose the fact that a procedure or function is prefixed "class".

Please file a bug report for this.

ii) I've got comments associated with class procedures/functions that are showing up in Lazarus, but not in fpdoc. What's the preferred format for these?

fpdoc does not read its descriptions from comments. It uses an XML format, as described in the FPDoc manual, which you can find on the FPC website.

Michael.

Mark Morgan Lloyd
to Michael Van Canneyt
Michael Van Canneyt wrote 19 lines
On Fri, 11 Feb 2011, Mark Morgan Lloyd wrote: > I'm currently working on a translator from SNMP MIB files to Pascal, > and on a whim decided to see how well they documented. Two questions > if I may. > > i) fpdoc appears to lose the fact that a procedure or function is > prefixed "class". Please file a bug report for this. > > ii) I've got comments associated with class procedures/functions that > are showing up in Lazarus, but not in fpdoc. What's the preferred > format for these? fpdoc does not read its descriptions from comments. It uses an XML format, as described in the FPDoc manual, which you can find on the FPC website.

I'll raise a bug in the morning (my time). My question was initially going to be "what format do I create"- it's obviously no real problem with machine-generated code.

Mark Morgan Lloyd markMLl .AT. telemetry.co .DOT. uk [Opinions above are the author's, not those of his employers or colleagues]