On 30/11/2007, Lee Jenkins <[EMAIL PROTECTED]> 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 interest. 3. Integrated LazDoc Editor - part of the Lazarus IDE and can be open by selecting View|LazDoc Editor. To edit the documentation with this editor, you first need to tell the Lazarus IDE where to find the xml documents. You do this by going to Project|Project Options|LazDoc tab. Add the path(s) to the xml files. Now you are ready to document your code. Simple place the cursor in the editor window on a Method, Class, Parameter etc and the LazDoc Editor will be ready to accept you documentation descriptions. I believe it auto saves when you move the cursor to another identifier. Once you have some documentation written in the xml files (though you can do this step with skeleton xml files as well) you can run 'fpdoc' to generate many HTML output files which will be the final formatted docs. For examples on how to use 'makeskel' or 'fpdoc', you can read the PDF document on fpdoc. You can also look in the Docs directory of the tiOPF project for script examples. Regards, - Graeme - _______________________________________________ fpGUI - a cross-platform Free Pascal GUI toolkit http://opensoft.homeip.net/fpgui/ _________________________________________________________________ To unsubscribe: mail [EMAIL PROTECTED] with "unsubscribe" as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
