Changeset 74941 in spip-zone

Timestamp:

Aug 25, 2013, 5:24:54 PM (8 years ago)

Author:

marcimat@…

Message:

Tout début d'une application pour simplifier l'usage du programme.
La doc de ce programme est écrite… avant d'être fonctionnelle…

Location:

_galaxie_/code.spip.net/autodoc/trunk

Files:

• bin/autodoc.php (modified) (1 diff)
• bin/autodoc_helper.php (added)
• composer.json (modified) (1 diff)
• installation.md (modified) (5 diffs)
• src/autodoc/Helpers (added)
• src/autodoc/Helpers/Command (added)
• src/autodoc/Helpers/Command/FromSvn.php (added)
• src/autodoc/Helpers/Generator.php (added)
• src/autodoc/Helpers/phpdoc_helper.xml (added)

_galaxie_/code.spip.net/autodoc/trunk/bin/autodoc.php

@@ -5 +5 @@
  *
  * phpDocumentor pour le code source de SPIP
+ *
+ * Cet exécutable charge l'application autodoc (= phpdocumentor + plugins pour SPIP)
+ * et utilise les mêmes arguments d'entrée que l'application phpDocumentor.
+ *
+ * Pour un usage simplifié, utiliser autodoc_helper.php
  */
 
-// determine base include folder, if @php_dir@ contains @php_dir then
-// we did not install via PEAR
-$bootstrap_folder =  __DIR__ . '/../src';
+require_once __DIR__ . '/../src/autodoc/Application.php';
 
-require_once $bootstrap_folder . '/autodoc/Application.php';
 $app = new autodoc\Application();
 $app->run();

_galaxie_/code.spip.net/autodoc/trunk/composer.json

@@ -3 +3 @@
     "autoload": {
         "psr-0":{
-            "autodoc": ["src/"]
+            "autodoc": "src/"
         }
     },

_galaxie_/code.spip.net/autodoc/trunk/installation.md

@@ -13 +13 @@
 --------------
 
-        mkdir output && mkdir log
         svn co svn://zone.spip.org/spip-zone/_galaxie_/code.spip.net/autodoc/trunk autodoc && cd autodoc
         curl -sS https://getcomposer.org/installer | php
         php composer.phar install
         cd ..
+
+En fonction de l'usage et du contenu de phpdoc.xml, il faudra créer un/des répertoires avec accès en écriture.
+
+* Avec l'application `autodoc/bin/autodoc_helper.php` :
+
+        mkdir work
+
+* Avec l'executable `autodoc/bin/autodoc.php` (et en fonction du phpdoc.xml) :
+
+        mkdir output && mkdir log
 
 
@@ -40 +49 @@
 =====
 
+Il y a deux exécutables disponibles.
+
+* L'un `autodoc.php` est l'équivalent de l'exécutable de phpdocumentor
+  mais charge en plus le plugins SPIP pour phpdocumentor. 
+
+* L'autre `autodoc_helper.php` est une application simplifiant l'utilisation
+  en préconfigurant les commandes à transmettre à l'exécutable.
+  Elle gère également le téléchargement des sources PHP à documenter.
+
+
+Exécutable autodoc.php
+----------------------
+
+Appel :
+
         php autodoc/bin/autodoc.php
 
@@ -45 +69 @@
 http://www.phpdoc.org/docs/latest/for-users/basic-usage.html
 
+L'exécutable sans paramètre affiche la liste des actions et peut afficher,
+pour chaque action ses arguments et options possibles.
 
-Appeler le template `zora`
---------------------------
+
+
+### Appeler le template `zora`
+
 
 Par commande :
@@ -69 +97 @@
 
 
-Autres options de configuration
--------------------------------
+
+### Autres options de configuration
+
 
 Dans le fichier `phpdoc.xml` il est possible de définir les options suivantes
@@ -95 +124 @@
 - presentation :
       si présent, ajoute cette information sur le sommaire de la documentation automatique générée.
+
+
+
+Exécutable autodoc_helper.php
+-----------------------------
+
+Appel :
+
+        php autodoc/bin/autodoc_helper.php
+
+L'exécutable sans paramètre affiche la liste des actions et peut afficher,
+pour chaque action ses arguments et options possibles.
+
+
+### Quelques commandes et exemples
+
+
+#### from:svn
+
+Générer la documentation depuis une source SVN quelconque.
+Par défaut, la sortie est enregistrée dans le répertoire `work/output/default`
+
+        php autodoc/bin/autodoc_helper.php from:svn svn://trac.rezo.net/spip/spip
+
+Forcer un préfixe de sortie ici dans `work/output/spip-dev` :
+
+        php autodoc/bin/autodoc_helper.php from:svn svn://trac.rezo.net/spip/spip --prefixe=spip-dev
+
+
+#### from:spip
+
+Générer la documentation depuis le svn du core
+
+        php autodoc/bin/autodoc_helper.php from:spip spip
+        php autodoc/bin/autodoc_helper.php from:spip branches/spip-3.0
+
+
+#### from:zone
+
+Générer la documentation depuis le svn de la zone
+
+        php autodoc/bin/autodoc_helper.php from:zone _plugins_/fabrique/trunk
+
+
+#### from:plugin
+
+Générer la documentation depuis le svn _plugins_ de la zone
+
+        php autodoc/bin/autodoc_helper.php from:plugin fabrique/trunk
+
+
+#### from:file
+
+Générer des documentations dont les sources sont indiquées dans un fichier
+
+        php autodoc/bin/autodoc_helper.php from:file autodoc.txt
+        php autodoc/bin/autodoc_helper.php from:file svn://zone.spip.org/spip-zone/autodoc.txt
+
+