FPDoc-Editor: when saving changes, XML validity must be checked, otherwise error in fpdoc
Original Reporter info from Mantis: warrence
-
Reporter name: Stefan Müller
Original Reporter info from Mantis: warrence
- Reporter name: Stefan Müller
Description:
Characters like "<" have to be manually replaced in the XML description files, otherwise causing fpdoc to fail (because they wreck the XML syntax) when converting the documentation to HTML (and likely when converting to something else as well). In addition, these manual changes are overwritten by the FPDoc Editor everytime something else changes in the XML file.
Additional information:
I'm documenting, for example, the overloaded operator "<" using the FPDoc Editor. The editor generates an XML tag, which looks like:
<element name="operator <(TPoint, TPoint): Boolean">
which is not a valid XML tag because of the extra "<". Because of this fpdoc terminates with an error when trying to convert this XML file into HTML. When I manually replace this tag by
<element name="operator <(TPoint, TPoint): Boolean">
fpdoc will convert this just as intended. The problem here is that when I change something different in the documentation (causing the FPDoc Editor to rewrite the XML file), my manually inserted "<" is replaced by "<" again. Finally I tried replacing the tag manually by
<element name="operator <(TPoint, TPoint): Boolean">
After that fpdoc does not recognize this node anymore as the node belonging to the operator "<", therefore leaving the documentaion page blank. Interestingly, this XML tag is not changed the way the one before was when rewriting the XML file.
Mantis conversion info:
- Mantis ID: 15120
- Version: 0.9.29 (SVN)
- Fixed in revision: 28526 (#7d14b1c3)
- Target version: 0.99.0