[lazarus] Documentation added to the site
cwhite at aracnet.com
Wed Mar 15 23:50:13 EST 2000
There are templates in the lcl/templates directory that contain comments that
were designed specifically for pasdoc. But there is a simple problem with the
way our files are setup and pasdoc (unless someone has fixed this since the
last time I looked at pasdoc). That is that pasdoc does not pick up the .inc
files. So it grabs all the documentation out of the .pp files but misses the
.inc files. Most of the procedures are documented in the .inc files. Like I
said, maybe this has been fixed since last I looked at pasdoc, but if not,
then that is probably why the documentation looks really thin.
Stefan Hille wrote:
> On Wed, Mar 15, 2000 at 05:16:59PM -0500, Michael A. Hess wrote:
> > Greetings,
> > I have added documentation to the web site. It is Pasdoc generated files
> > of the LCL. At this point it is very dry since not much in the way of
> > documentation has every been added to the source code.
> Although I've tried to document most methods there's not much in the
> documentation right now. Could you give an example of how to write pasdoc
> compliant docs?
> BTW: I hate to write documentation in the interface section since from my
> point of view it almost ever hides the information I'm looking for
> when searching through class declarations. Thus I'd prefer to have the
> docs in the implementation part but then it's difficult to
> document variables and properties. Anybody here who has a solution for
> this topic?
> Stefan Hille email: stoppok at osibisa.ms.sub.org
> 48155 Muenster voice: 0251/664695
More information about the Lazarus