[fpc-pascal] Extending FPDoc

Darius Blaszijk dhkblaszyk at zeelandnet.nl
Sun Sep 18 09:02:29 CEST 2005


On Fri, 2005-09-16 at 22:17, Michael Van Canneyt wrote:
> I'd rather you keep these todo separate. It'll slow down parsing
> (which is already horribly slow) and I see no added value. If you must
Could you elaborate on that?? I don't see a problem in adding a tag.
While indeed it will slow down parsing by a few mSec per node, the
generated pages will not suffer from this at all. Instead more useful
text will be shown for developers. Because that's the audience the
documentation is meant for right??

> In lazarus, you could even store the TODO in a separate file. If I'm correct,
> Lazarus has already a TODO system.
True, but it does not show in the documentation obviously.

> What concerns notes, there is already a <topic> node. It is meant for 'Extra' text.
> You can use that inside the package or module node.
Ok, good to hear, but can I use it also at the element level?? Although
pakage notes are usefull, they will never get into that much detail as
element notes. What I have in mind are detailed notes per element on
certain aspects in the code.

Darius





More information about the fpc-pascal mailing list