PhpClassView
A standalone classbrowser and documentation-tool for PHP-classes
Download PhpClassView
PhpClassView FAQ
-
Is PhpClassView available for other operating-systems than Windows?
No, currently PhpClassView is only available for Windows.
-
PhpClassView doesn't seem to work/startup on my computer, is there anything else i need?
Yes, you need to install the .NET Framework version 2.0 or above.
-
Is phpclassview free software?
Yes, it's completely free. For more details you may want to take a look at the license.
-
What kind of code-comments does phpclassview consider for generating documentations?
It parses and interprets Javadoc/PHPDoc-style comments.
The current release (version 0.3.7) supports the following comment-tags:
@param, @return, @var, @example, @author, @version, @category, @package, @license, @copyright, @deprecated and the long and short description
of a class or a member.
Since version 0.3.7 inline-links ({@link ...}) are also supported.
-
What are JavaDoc/PHPDoc-comments and how do they look like?
Javadoc/PHPDoc-comments are standardised comment-blocks for documentating PHP-classes.
A complete overview of the standard and all available comment-tags can be found
here.
-
PhpClassView doesn't seem to show/generate the documentation of a php-class correctly over here. What to do?
This may be due to a corrupted classstructure (does the class work?) or simply due to a bug in phpclassview.
To fix the problem in future versions, please send the php-class together with a short description of the problem
to phpclassview | at | cuab.de. Thanks!
.. to be continued.