Hello,

There are several things that I do not understand in fpDoc (maybe because of the usage by Lazarus that is missing few features):
1. Let's say I have a class, enum, record etc... How do I make sure that each property/field/item that I want to document will be belong to the proper container ?

2. Is there a way to create a link for a remote site (for example wikipedia, specific RFC etc) ?
3. How can I "compile" fpDoc using fppkg ?

Thanks,

Ido

LINESIP - Opening the source for communication
http://www.linesip.com
http://www.linesip.co.il

ik wrote

1. Let's say I have a class, enum, record etc... How do I make sure that each property/field/item that I want to document will be belong to the proper container ?

It is defined in the fpdoc xml documentation file via the "element" tag.

eg: for a type:

<element name="TMyColor">
<short>bla bla...</short>
<descr>...</descr>
</element>

eg: for a field of a record

<element name="TMyRecord.MyField">
<short>MyField support...</short>
</element>

eg: for an enum

<element name="TMyType">
<short>Enum type defining....</short>
</element>

2. Is there a way to create a link for a remote site (for example wikipedia, specific RFC etc) ?

You use the "url" tag.

eg:

<descr>
<p>
For more information, see the FPC website at: <url href="http://www.freepascal.org" />
</p>
</descr>

3. How can I "compile" fpDoc using fppkg ?

no idea.

> 3. How can I "compile" fpDoc using fppkg ? no idea.

fppkg does not compile anything, fpmake does. See:

Though the report is not closed, the patch was comitted.

Darius