rjPasDoc 0.6.21 ReadMe

rjPasDoc generates HTML documentation from comments in Pascal unit source code files. It is the only free help generator that flawlessly follows compiler defines and include files.

rjPasDoc is a command line program written in Delphi Pascal. It continues the development of PasDoc, originally written by Marco Schmidt and published under GNU General Public License (GPL). The original source at did not compile with Delphi, so I worked on it a bit so it now compiles with Delphi. I also fixed quite a few bugs and introduced some new features. rjPasDoc successfully compiles with Delphi 4 and Delphi 5. Other versions are yet untested, but should work as well.

Author

Ralf Junker http://www.zeitungsjunge.de/delphi/

All changes to the original PasDoc sources are copyright Ralf Junker 2001. Visit http://www.zeitungsjunge.de/delphi/ for updates. This version is released on 21 June 2001.

License

Since the original PasDoc is Open Source under GPL, rjPasDoc is also released as Open Source under GPL. Click here to view the GPL.

Usage

Full PDF documentation is available for the original PasDoc at the PasDoc homepage. I have tried not to break the program's functionality, so that document will serve as a good introduction.

I have corrected some bugs to the original version (and probably introduced some new ones), fixed some of the functionality and added a few new features:

Limitations

LaTeX output is untested. Due to modifications of the main generator engine, I don't expect it will work. Since I do not use LaTeX at all, I will probably remove it from the program some time.

Open Issues

Lots could be done, but time is precious. Some more customizations (colors, fonts, etc.) should be among the more simple things on the list. Speaking in more general terms, templates would be nice to have.

Frames would improve HTML layout a lot, making it look more like the Delphi Help with class properties and methods on the left and their descriptions on the right.

Improved parsing for records is also needed. Also, forward class declaration are not yet recognized correctly. The code could be made (more) Delphi-like, objects changed into classes, long strings used instead of short strings, compiler warnings removed, etc. Last but not least, it needs some more testing.

Concluding

rjPasDoc does it job, so have fun with it. I hope that at least somebody will be able to use it for something useful.

If you have any opinion on rjPasDoc, please e-mail me. I will be glad to receive feedback, suggestions, bug-fixes and new features.