Changeset 74941 in spip-zone


Ignore:
Timestamp:
Aug 25, 2013, 5:24:54 PM (6 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:
6 added
3 edited

Legend:

Unmodified
Added
Removed
  • _galaxie_/code.spip.net/autodoc/trunk/bin/autodoc.php

    r74567 r74941  
    55 *
    66 * phpDocumentor pour le code source de SPIP
     7 *
     8 * Cet exécutable charge l'application autodoc (= phpdocumentor + plugins pour SPIP)
     9 * et utilise les mêmes arguments d'entrée que l'application phpDocumentor.
     10 *
     11 * Pour un usage simplifié, utiliser autodoc_helper.php
    712 */
    813
    9 // determine base include folder, if @php_dir@ contains @php_dir then
    10 // we did not install via PEAR
    11 $bootstrap_folder =  __DIR__ . '/../src';
     14require_once __DIR__ . '/../src/autodoc/Application.php';
    1215
    13 require_once $bootstrap_folder . '/autodoc/Application.php';
    1416$app = new autodoc\Application();
    1517$app->run();
  • _galaxie_/code.spip.net/autodoc/trunk/composer.json

    r74567 r74941  
    33    "autoload": {
    44        "psr-0":{
    5             "autodoc": ["src/"]
     5            "autodoc": "src/"
    66        }
    77    },
  • _galaxie_/code.spip.net/autodoc/trunk/installation.md

    r74921 r74941  
    1313--------------
    1414
    15         mkdir output && mkdir log
    1615        svn co svn://zone.spip.org/spip-zone/_galaxie_/code.spip.net/autodoc/trunk autodoc && cd autodoc
    1716        curl -sS https://getcomposer.org/installer | php
    1817        php composer.phar install
    1918        cd ..
     19
     20En fonction de l'usage et du contenu de phpdoc.xml, il faudra créer un/des répertoires avec accès en écriture.
     21
     22* Avec l'application `autodoc/bin/autodoc_helper.php` :
     23
     24        mkdir work
     25
     26* Avec l'executable `autodoc/bin/autodoc.php` (et en fonction du phpdoc.xml) :
     27
     28        mkdir output && mkdir log
    2029
    2130
     
    4049=====
    4150
     51Il y a deux exécutables disponibles.
     52
     53* L'un `autodoc.php` est l'équivalent de l'exécutable de phpdocumentor
     54  mais charge en plus le plugins SPIP pour phpdocumentor.
     55
     56* L'autre `autodoc_helper.php` est une application simplifiant l'utilisation
     57  en préconfigurant les commandes à transmettre à l'exécutable.
     58  Elle gère également le téléchargement des sources PHP à documenter.
     59
     60
     61Exécutable autodoc.php
     62----------------------
     63
     64Appel :
     65
    4266        php autodoc/bin/autodoc.php
    4367
     
    4569http://www.phpdoc.org/docs/latest/for-users/basic-usage.html
    4670
     71L'exécutable sans paramètre affiche la liste des actions et peut afficher,
     72pour chaque action ses arguments et options possibles.
    4773
    48 Appeler le template `zora`
    49 --------------------------
     74
     75
     76### Appeler le template `zora`
     77
    5078
    5179Par commande :
     
    6997
    7098
    71 Autres options de configuration
    72 -------------------------------
     99
     100### Autres options de configuration
     101
    73102
    74103Dans le fichier `phpdoc.xml` il est possible de définir les options suivantes
     
    95124- presentation :
    96125      si présent, ajoute cette information sur le sommaire de la documentation automatique générée.
     126
     127
     128
     129Exécutable autodoc_helper.php
     130-----------------------------
     131
     132Appel :
     133
     134        php autodoc/bin/autodoc_helper.php
     135
     136L'exécutable sans paramètre affiche la liste des actions et peut afficher,
     137pour chaque action ses arguments et options possibles.
     138
     139
     140### Quelques commandes et exemples
     141
     142
     143#### from:svn
     144
     145Générer la documentation depuis une source SVN quelconque.
     146Par défaut, la sortie est enregistrée dans le répertoire `work/output/default`
     147
     148        php autodoc/bin/autodoc_helper.php from:svn svn://trac.rezo.net/spip/spip
     149
     150Forcer un préfixe de sortie ici dans `work/output/spip-dev` :
     151
     152        php autodoc/bin/autodoc_helper.php from:svn svn://trac.rezo.net/spip/spip --prefixe=spip-dev
     153
     154
     155#### from:spip
     156
     157Générer la documentation depuis le svn du core
     158
     159        php autodoc/bin/autodoc_helper.php from:spip spip
     160        php autodoc/bin/autodoc_helper.php from:spip branches/spip-3.0
     161
     162
     163#### from:zone
     164
     165Générer la documentation depuis le svn de la zone
     166
     167        php autodoc/bin/autodoc_helper.php from:zone _plugins_/fabrique/trunk
     168
     169
     170#### from:plugin
     171
     172Générer la documentation depuis le svn _plugins_ de la zone
     173
     174        php autodoc/bin/autodoc_helper.php from:plugin fabrique/trunk
     175
     176
     177#### from:file
     178
     179Générer des documentations dont les sources sont indiquées dans un fichier
     180
     181        php autodoc/bin/autodoc_helper.php from:file autodoc.txt
     182        php autodoc/bin/autodoc_helper.php from:file svn://zone.spip.org/spip-zone/autodoc.txt
     183
     184
Note: See TracChangeset for help on using the changeset viewer.