Sign in Join

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

Mailing lists / lazarus / 2009-11

fpdoc / something like a general topic, not bound to a method?

4 messages · 3 people · –

Reply by email Subscribe to this list Your subscription

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

Martin

In FPDoc is it possible to create an extra page, that is not bound to a method, property or other code?

Sometimes several Methods deal with some kind of problem, in order to give some background on the issue it would be nice to have a page, where you could describe the background. This page would then be linked (see-also) in all relevan topics.

At the moment all I found is to stuff this info on a (randomly) selected method, and link to that (but then the link in see-also) carries the short descripton of that method, which gives no clue about the extra info)

Martin

Reply by email

Michael Van Canneyt
to Martin: In FPDoc is it possible to create an extra page, that is not bound to a method, property…
Martin wrote
In FPDoc is it possible to create an extra page, that is not bound to a method, property or other code?

Yes. A topic:

<topic name="mytopic">
<short>Very interesting to know</short>
<descr>
Topic text goes here
</descr>
<seealso>
<link id="OtherInterestingTopic"/>
</seealso>
</topic>

It can appear at the package or module level, and you can nest topics 1 level deep.

It's documented.

Michael.

Reply by email