fpdocp

FreePascal compiler contain tool called FPDoc for generating documentation from source code. Unlike other similar tools like JavaDoc or Doxygen, FPDoc read textual information not from source code but from external, specially formated XML file.

This implementation approach has pros and cons.

Cons:

- you must maintain documentation on 2 places, one in source code and one in extra XML file. Thus XML or source code documentation may be out of date

Pros:

- You can create your own preprocessor which convert JavaDoc or doxygen-like comments from your source and generate XML file

This project fpdocp is that kind of preprocessor. It analyze all source from given directory and create coresponding XML file for FPDoc.

Tags

  pascal documentation freepascal source doxygen preprocessor javadoc

Share