[fpc-devel] [RFC] fpdoc output comment from the source

L505 fpc505 at z505.com
Sun Dec 4 11:48:45 CET 2005


> Please make sure that the fpdoc commenting logic is clearly separated from
> the CGI logic. This way your changes can maybe be incorporates in the FPC
> sources and website.

Yup that's what I planned on doing to modularize development..  A separate database
of user comments will be "included" below the permanent FPDOC HTML documentation. The
permanent documentation (or at least compiled, not exactly permanent) will exist
separately from the database of user comments. This way none of the existing FPDOC
source code needs to be changed. Only the CGI program gets installed on a server and
it includes each FPDOC HTML page as if it were a PHP include file or a php Read(). Of
course I'm not using PHP, so in Pascal terms.. WebFileOut().

We can have documentation mirrors via XML feeds.. but since I don't like XML so much
I'd actually consider spitting out an SQL dump or an SDS (simple data storage) dump,
or a CSV (comma delimitted) dump of the user comments. The user comments could be
parsed by freepascal.org by getting the CSV dump or SQL dump just like an RSS feed
does. In addition to live dumps, just a download of the current database dump will be
available.




More information about the fpc-devel mailing list