[lazarus] Documentation added to the site

Jarto Tarpio jarto at starsoft.fi
Thu Mar 16 08:29:28 EST 2000


So far I've just been lurking, so I have to say hi and thank you for 
your hard work on Lazarus. I'm looking forward to contributing 
something when life gets a bit less hectic :-)

> On Thu, 16 Mar 2000, Michael A. Hess wrote:
> I would also warn against the using of the implementation section;
> it will mean that you must extend pasdoc to a full-blown pascal parser,
> because the implementation can have very difficult constructs.

I haven't used pasdoc, so I don't know how it works but I've usually 
written comments to the implementation section in the following 
way:

procedure TSmile.Paint;
//  This one draws the TSmile-component
//  This is the main comment area and everything
//  I write here is picked up as comments.
begin
  Canvas.RectFill(Rect(0,0,Width,Height)); //Clean it
  DrawSmile; // :-) <- that's it
  ....
end;

Then I have a small program that finds all those comments where 
pos('//',SourceLine)=1 and makes html-code from those including 
the procedure- and functions-lines.

The documentation looks like:

procedure TSmile.Paint

  This one draws the TSmile-component
  This is the main comment area and everything
  I write here is picked up as comments.

procedure TSmile. and so on.....

/jarto






More information about the Lazarus mailing list