[fpc-devel] fpdoc content syntax suggestion

Michael Van Canneyt michael at freepascal.org
Fri Jul 9 13:41:23 CEST 2010

On Fri, 9 Jul 2010, Graeme Geldenhuys wrote:

> Op 2010-07-09 11:26, Michael Van Canneyt het geskryf:
>> In that case, you'll still have problems with < and > (and possibly other)
>> characters, unless you plan to put everything in CDATA sections.
> Yes, that would be required if we stay with the XML format, I don't see any
> other way around it, and I definitely wouldn't want to introduce escaped
> text inside the documentation content, just to get around the XML format
> issue. Again, no extra burden should be placed on the documentation writer
> - simply writing documentation is already a burden enough. :)
> Alternatively (which I believe is not desired - and wasn't my plan either),
> is to use a totally different file format than XML. I guess for the sake of
> covering all basis, what do others think of this? Personally, I don't see
> an issue with staying with XML and simply put all <descr> and <short>
> content inside a CDATA block. I assume the fcl-xml units know how to handle
> CDATA blocks?


Not using XML would require a major rewrite of fpdoc - it is deeply rooted
in XML, as you'll find out - and I am not very keen on this. So hold your
horses there, please...


More information about the fpc-devel mailing list