/ Home / LJCPHPProjects / GenDoc


PHP GenDoc

The GenDoc app generates HTML documentation from PHP source file XML comments. It also uses external XML Comment files which are referenced by source file "include" XML comments.

The GenDoc project group has three projects:

GenCodeDoc

Uses DocDataLib/LJCDocDataLib and GenDataLib/LJCGenDataGenLib for each PHP file to generate the CodeDoc HTML files.

GenCodeDocFiles.cmd The example command file.
GenCodeDocFiles.php The example program entry file.
GenCodeDocLib.php The library file which contains the GenCodeDoc class.
Uses: DocDataLib, GenDataLib and GenTextLib.
GenCodeSourceFileList.txt The list of PHP files for which HTML Documentation will be generated.
ReadMeGenCodeDoc The GenCodeDoc ReadMe file.

DocDataLib

Creates the DocData XML from a PHP source file.

TestDocDataGen.cmd The example command file.
TestDocDataGen.php The example program entry file.
DocDataGenLib.php Contains classes to generate DocData XML strings and optionally files.
DocDataLib.php Contains classes to represent DocData.
LJCIncludeLib.php Parses code XML Comments from a referenced Include file.
LJCCommentsLib.php Parses the code XML Comments
LJCParamCommentLib.php Parses the <param> XML Comments.
ReadMeDocDataLib The DocDataLib ReadMe file.

GenDataLib

Creates the GenData XML from a DocData XML file. Also creates the HTML files by combining the GenData and an HTML Text Template.

LJCGenDataGenLib.php Contains Classes to generate GenData XML strings and optionally files.
LJCGenDataXMLLib.php Contains the LJCGenDataXML class for generating static GenData XML text.
ReadMeGenDataLib The GenDataLib ReadMe file.