[fpc-pascal] fpdoc cleanup after a refactor

Michael Van Canneyt michael at freepascal.org
Tue Aug 14 14:42:11 CEST 2007



On Tue, 14 Aug 2007, Graeme Geldenhuys wrote:

> Hi,
> 
> What is the best method to clean up documentation files after a class
> or unit refactor was done. My xml files are all outdated now -
> referencing methods or sometimes even classes that don't exist
> anymore.
> 
> What is the options available to me. Lets hope I have more choices
> than to recreate the xml file with makeskel and manually copy and
> paste all relevant documentation into the new xml file. This will take
> forever because the nodes are not in the same order, etc.!

Well, makeskel has an update option. It will generate nodes for all
missing elements.

What more can you expect ? 
We could add some map feature so it remaps nodes. 
But that would mean you'll need to create the map.
 
> If there is no easy solution with fpdoc, my other long term solution
> would possibly be to move back to PasDoc with embedded docs. That seem
> to be easier to manage with evolving code. That also means I would
> have to write a new HTML output format for PasDoc, because I really
> like the fpdoc's generated HTML layout. PasDoc's default HTML layout
> is just crap and to busy.
> 
> ps:
>   Will the fpdoc.css file used by FPC and Lazarus docs be included as
> the default in the next FPC release?  The default css file in FPC
> 2.0.4 look crap compared to the one used on the web.

? It's the same file.

Michael.



More information about the fpc-pascal mailing list