Login   Register  
PHP Classes
elePHPant
Icontem

Class Doc: Generate PHP code documentation in multiple idioms

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Info   Screenshots Screenshots   View files View files (18)   DownloadInstall with Composer Download .zip   Reputation   Support forum (1)   Blog    
Last Updated Ratings Unique User Downloads Download Rankings  
2006-03-01 (8 years ago) RSS 2.0 feedNot enough user ratingsTotal: 1,638 All time: 2,218 This week: 1,572Up
Version License Categories  
odoc 1.0.0Free for non-commercial...PHP 5, Utilities and Tools
Description Author  

This package can be used to process PHP code to generate automatic documentation in a configurable idiom.


CREDITS

A very special thanks to Bastian Gorke for his contribution, he added the German translation!
Thanks a lot, Bastian! :-)

Un grand merci à Bastian Gorke pour sa contribution, il a ajouté la traduction en allemand!
Merci beaucoup, Bastian! :-)


README

Ce script est un script de documentation de classes et de fonctions.
L'utilisation est très simple :

CLASSES :
Leur analyse fonctionne par package.
Un formulaire sert à créer un package.
Un autre sert à uploader des classes dans un package. Si vous avez des classes héritant d'autres classes,
vous devez uploader ces classes parentes dans le package.
Un 3ème forumaire, enfin, sert à analyser le package complet.
Une documentation sera créée, avec un index propre au package, contenant le diagramme d'héritages du package.


FONCTIONS :
Un formulaire sert à uploader le fichier de fonction, un autre à analyser les fichiers uploadés.
Seules les fonctions 'user_defined' seront analysées.


Une collection de fichiers html sont alors créés, facilement transportable dans un autre script
donc on veut documenter les classes ou/et fonctions.

A noter que l'on peut analyser n'importe quelle classe, y compris une classe interne.

La documentation est localisée. Pour le moment, sont supportés l'anglais, le français et l'allemand.
Il est très facile de créer une traduction : il suffit de rajouter une langue dans les fichiers xml
qui se trouvent dans le répertoire 'locales'.

J'ai mis dans le répertoire css/ différentes css, pour montrer que le design est très facilement
modifable. Il suffit pour cela de nommer la css voulue "maindoc.css".

index.php passe par l'interface utilisateur
index2.php montre comment ne pas passer par cette interface (il faut au prélable mettre les classes
à documenter dans le répertoire 'classes')

REPERTOIRES :

class/ => contient les classes faisant fonctionner le script : odocclass.cls.php, odocfunc.cls.php, olocale.cls.php et ohtml.cls.php
classes/ => contient les classes à analyser
fonctions/ => contient les fichiers de fonctions à analyser
css/ => contient la css de la documentation
docs/"langue"/"package"/classes/ et docs/"langue"/fonctions/ => lorsque une classe ou une fonction est analysée, ce répertoire est créé, ainsi qu'un sous-répertoire
du nom de la classe/fonction étudiée. Dans ce sous-répertoire se trouvent les fichiers
html de la documentation
locales/ => contient les fichiers xml de localisation



This script is a classes and functions documentation tool.
It's easy to use :

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 thirs 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.


FONCTIONS :
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


It 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.

Picture of Johan Barbier
Name: Johan Barbier <contact>
Classes: 17 packages by
Country: France France
Age: 42
All time rank: 412 in France France
Week rank: 102 Down5 in France France Down
Innovation award
Innovation award
Nominee: 6x

Screenshots  
  • screenshot.jpg
  Files folder image Files  
File Role Description
Files folder imageclass (4 files)
Files folder imagecss (1 file)
Files folder imagelocales (3 directories)
Accessible without login Plain text file index.php Appl. index page
Plain text file localize.check.php Appl. Localization form checker
Accessible without login HTML file localize.form.html Data Localization form
Accessible without login Plain text file readme.txt Doc. README

  Files folder image Files  /  class  
File Role Description
  Accessible without login Plain text file odocclass.cls.php Class classes documentation
  Accessible without login Plain text file odocfunc.cls.php Class Functions documentation class
  Accessible without login Plain text file ohtml.cls.php Class html generator class
  Accessible without login Plain text file olocale.cls.php Class localization class

  Files folder image Files  /  css  
File Role Description
  Accessible without login Plain text file maindoc.css Data css file

  Files folder image Files  /  locales  
File Role Description
Files folder imagedeutsch (3 files)
Files folder imageenglish (3 files)
Files folder imagefrancais (3 files)

  Files folder image Files  /  locales  /  deutsch  
File Role Description
  Plain text file doc.xml Data German documentation messages
  Plain text file errors.xml Data German error messages
  Plain text file gui.xml Data German UI messages

  Files folder image Files  /  locales  /  english  
File Role Description
  Plain text file doc.xml Data English documentation messages
  Plain text file errors.xml Data English error messages
  Plain text file gui.xml Data English UI messages

  Files folder image Files  /  locales  /  francais  
File Role Description
  Plain text file doc.xml Data French documentation messages
  Plain text file errors.xml Data French error messages
  Plain text file gui.xml Data French UI messages

 Version Control Unique User Downloads Download Rankings  
 0%Total:1,638All time:2,218
 This week:0This week:1,572Up