|
ClassDoc |
 |
 Informations rapides |
|
|
| Informations détaillées |
|
Point fort :
Documentation automatique localisée de classes et de fonctions
Description :
CREDITS
A very special thanks to Bastian Gorke for his contribution he added the German translation
Thanks a lot Bastian
Un grand merci a Bastian Gorke pour sa contribution il a ajoute la traduction en allemand
Merci beaucoup Bastian
README
Ce script est un script de documentation de classes et de fonctions
L utilisation est tres simple
CLASSES
Leur analyse fonctionne par package
Un formulaire sert a creer un package
Un autre sert a uploader des classes dans un package Si vous avez des classes heritant d autres classes
vous devez uploader ces classes parentes dans le package
Un 3eme forumaire enfin sert a analyser le package complet
Une documentation sera creee avec un index propre au package contenant le diagramme d heritages du package
FONCTIONS
Un formulaire sert a uploader le fichier de fonction un autre a analyser les fichiers uploades
Seules les fonctions user defined seront analysees
Une collection de fichiers html sont alors crees 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 localisee Pour le moment sont supportes l anglais le francais et l allemand
Il est tres facile de creer une traduction il suffit de rajouter une langue dans les fichiers xml
qui se trouvent dans le repertoire locales
J ai mis dans le repertoire css differentes css pour montrer que le design est tres 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 prelable mettre les classes
a documenter dans le repertoire 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 a analyser
fonctions contient les fichiers de fonctions a analyser
css contient la css de la documentation
docs langue package classes et docs langue fonctions lorsque une classe ou une fonction est analysee ce repertoire est cree ainsi qu un sous repertoire
du nom de la classe fonction etudiee Dans ce sous repertoire 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
|
|
|
Télécharger maintenant
|
|
| Informations & services |
 |
|
|
|
 Options
Détails
Tips
Top KitGrafik
|
Librairie
