DocHTML Class
Name: DocHTML
Description:
- * DocHTML parses PHP class file comments and generates documentation
Package: org.active-link.doc
Author: Zurab Davitiani
Version: 0.4.0
Requires: XML, PHPClass, Method
See: PHPClass
All Methods
DocHTML
getClassDoc
getClassDocFromClass
getClassDocFromFile
DocHTML
( )
Description:
- * Constructor, runs when new object instance is created, sets default values
getClassDoc
( mixed argument )
Description:
- * Returns class documentation as a string, formatted in HTML
- * If argument is a filename, it parses the file for comments and generates documentation
- * If argument is an object of type PHPClass, then documentation is generated from it
Returns: string HTML-formatted documentation if successful, false otherwise
Arguments:
getClassDocFromClass
( object objClass )
Description:
- * Returns class documentation as a string, formatted in HTML
Returns: string HTML-formatted documentation if successful, false otherwise
Arguments:
getClassDocFromFile
( string filename )
Description:
- * Returns class documentation as a string, formatted in HTML
Returns: string HTML-formatted documentation if successful, false otherwise
Arguments: