Class Doc 1.0

Class Doc can be used to process PHP code to generate automatic documentation in a configurable idiom. This script is a classes and functions documentation tool.

CLASSES:
- Their analysis is based on packages.
- A first form is used to create a package name.
- A second one is used to upload classes in the package. If you have inherited classes, you MUST upload these
parent classes in the package, too.
- A third form, finally, is used to analyze a chosen package.
The documentation is then created, with an index page for the package, displaying a diagram for the classes hierarchy.

FUNCTIONS:
A first form is used to upload the functions files, and a second one to analyze the chosen file. HTML files are then created, you can easily move wherever you want to give access to the documentation.

The documentation tool is localized: up to now, only English, French and German are supported. But it is very easy to create a new language : you just have to translate all the xml files located in the folder 'locales'. Then, just add the nez language button in the file 'localize.form.html'.

I have put in the 'css' folder various css. The one used will be the one named 'maindoc.css'. You can create yours quite easily.

FOLDERS :
- class/ => here are the tool classes : odocclass.cls.php, odocfunc.cls.php, olocale.cls.php and ohtml.cls.php
- classes/ => here are the uploaded classes to be analyzed
- fonctions/ => here are the uploaded functions files to be analized
- css/ => here are the css files (maindoc.css being the one currently used)
- docs/'language_name'/"package_name"/classes and docs/'language_name'/fonctions => here are the html documentation files
= locales/ => here are the xml translation files

Class Doc uses PHP 5 reflection support to obtain details of the definitions of classes and functions. It produces documentation from the analyzed PHP code that can be generated in one of the supported idioms. Currently, only English and French are supported.

License type: Free for non-commercial purposes.
Date added: 8 years, 1 month 21 days ago | Last updated: 8 years, 1 month 21 days ago

More popular Utilities & Tools

This is actually one of the most advanced image hosting script. The imagetize key features: SEO, Ads Ready, Admin

Listing Files

class-doc
locales
francais
  • doc.xml
  • 999 Bytes
  • 03/01/2006 02:22:44
english
  • doc.xml
  • 956 Bytes
  • 03/01/2006 02:22:44
deutsch
  • doc.xml
  • 985 Bytes
  • 03/01/2006 02:22:44
class
Hot Scripts
Sponsors