Sign in Join

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

Mailing lists / fpc-pascal / 2010-05

fpDoc Question

3 messages · 2 people ·

Reply by email Subscribe to this list Your subscription

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

Lee Jenkins

Does fpDoc per chance understand the markup used by pasdoc? Specifically, I used comments like this:

{: Particularly useful when applied to THusband or TBoyfriend. }
ICleaner  interface
   procedure CleanAfterSelf;
end;
{: Particularly useful when applied to TWife or TGirlfriend. }
IGymnast = interface
   procedure AssumeRandomFlexiblePosition;
end;

The colon after the opening brace tags at as a comment to actually render whereas a comment without the ":" does not get generated.

Warm Regards, Lee

Reply by email

Graeme Geldenhuys
to Lee Jenkins
Lee Jenkins wrote
Does fpDoc per chance understand the markup used by pasdoc?  Specifically, I used comments like this:

fpdoc doesn't use comments from inside the source code. Instead it reads the comments from an external XML file and merging it with the source code to generate the final output.

Lazarus's Tooltip Help does read from both external XML and code comments, but you cannot export those tooltip help to some help format.

The age old debate (similar to spaces or tabs used as formatting). I much prefer external help, because to have detailed help and that help is as code comments, your code because very quickly unreadable. tiOPF's code comments help is already a borderline case.

It should be the job of the IDE to make help available as tooltips, help window etc - all without the need for code comments. Lazarus IDE shows this is quite possible and does a fairly good job of it.

Regards, - Graeme - _______________________________________________ fpGUI - a cross-platform Free Pascal GUI toolkit http://opensoft.homeip.net/fpgui/

Reply by email

Lee Jenkins
to Graeme Geldenhuys
Graeme Geldenhuys wrote 22 lines
On 8 May 2010 15:53, Lee Jenkins wrote: > Does fpDoc per chance understand the markup used by pasdoc? Specifically, I > used comments like this: fpdoc doesn't use comments from inside the source code. Instead it reads the comments from an external XML file and merging it with the source code to generate the final output. Lazarus's Tooltip Help does read from both external XML and code comments, but you cannot export those tooltip help to some help format. The age old debate (similar to spaces or tabs used as formatting). I much prefer external help, because to have detailed help and that help is as code comments, your code because very quickly unreadable. tiOPF's code comments help is already a borderline case. It should be the job of the IDE to make help available as tooltips, help window etc - all without the need for code comments. Lazarus IDE shows this is quite possible and does a fairly good job of it.

Ah, that right. I looked at it once, but almost all of my fpc code is shared with delphi so I've been using pasdoc for a while now.

Just curious. Thanks again.

Warm Regards, Lee

Reply by email