1 Dec 01:06
Re: FPDoc or PasDoc?
Lee Jenkins <lee <at> datatrakpos.com>
2007-12-01 00:06:50 GMT
2007-12-01 00:06:50 GMT
Graeme Geldenhuys wrote: > On 30/11/2007, Lee Jenkins <lee <at> datatrakpos.com> wrote: >> Thanks guys. It does seem a bit more work, but I've been looking at the >> docs/wiki, etc and it looks like the IDE add-in could help, but I have no clue >> as to how to use it! > > Which IDE add-in is that? > > >> Am I supposed to write the actual xml markup using it? Or is it preferred to >> use a separate XML editor? > > > OK, I'm not sure how familiar you are with fpdoc, so I'll cover the basics. > > Lets say you have no docs, just you source code. You use the tool > called 'makeskel' which will generate skeleton xml description files > of each source code unit. The xml layout is quite a flat hierachy so > is easy to edit with a plain editor (if needed). > > No to actually write the documentation (which will be in the xml > files) you can use one of three tools. > > 1. A plain editor - handy in a pinch or for quick fixes or when you > know the fpdoc syntax. > > 2. LazDoc - located in the lazarus\doceditor directory. It's a > external tool to edit the xml files. It has many features to help you > and toolbar buttons to insert simple syntax in the descriptions. To > edit a xml file you select File|Open and select the xml file of(Continue reading)
Regards,
- Graeme -
_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
RSS Feed