Discussion :

[Mistic100]

Bonjour à tous,

Je suis un des développeurs du logiciel Piwigo, dans lequel il n'y a que très peu de classes, surtout des bon gros fichiers plein de fonctions...

Je suis entrain d'essayer de générer une doc technique avec PHPDocumentor. Mon problème et pour ces fichiers de fonctions (genre http://piwigo.org/svn/trunk/include/functions.inc.php)

Je voudrais que toutes les fonctions de chaque fichier apparaissent sur une page distincte dans le doc, avec une entrée dans le menu principal.

Après quelque recherche j'ai vu le paramètre @package, qui soit être mit dans un page-level DocBlock, j'ai alors ajouté

Code php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
/**
 * @package functions
 */

après la série d'includes, aucun changement, les fonctions du fichier sont toujours en vrac sur la première page.
Puis je me suis dit qu'il considérait le Copyright comme premier DocBlock de la page, alors j'ai mi mon info de package juste après <?php, pas mieux

quelqu'un saurait la bonne façon de faire ?

mon fichier de config pour info

Code xml :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor>
    <title><![CDATA[Piwigo]]></title>
    <parser>
        <default-package-name>piwigo</default-package-name>
        <encoding>utf-8</encoding>
        <target>C:\wamp\www\piwigo_doc\out</target>
    </parser>
    <transformer>
        <target>C:\wamp\www\piwigo_doc\out</target>
    </transformer>
    <files>
        <directory>C:\wamp\www\piwigo_trunk\include</directory>
        <directory>C:\wamp\www\piwigo_trunk\admin\include</directory>
 
        <ignore>include/smarty/</ignore>
        <ignore>include/php_compat/</ignore>
        <ignore>include/phpmailer/</ignore>
        <ignore>include/cssmin.class.php</ignore>
        <ignore>include/feedcreator.class.php</ignore>
        <ignore>include/jshrink.class.php</ignore>
        <ignore>include/mdetect.php</ignore>
        <ignore>include/passwordhash.class.php</ignore>
        <ignore>admin/include/pclzip.lib.php</ignore>
        <ignore>admin/include/mysqldump.php</ignore>
    </files>
</phpdocumentor>

[Mistic100]

à noter que si je met un namespace dans mon fichier

Code php :

Sélectionner tout - Visualiser dans une fenêtre à part

namespace functions;

c'est bien prit en compte pendant la génération

seulement ce n'est pas une solution, nous voulons garder la compatibilité PHP 5.2 (ça obligerais à réécrire pas mal de trucs)

[Mistic100]

Apparemment le template de base ne gère pas les packages
https://github.com/phpDocumentor/tem...clean/issues/4
et les autres dispos ne me plaisent pas vraiment

c'est quand même bizarre d'avoir le template par défaut qui ne gère pas toutes les fonctions du programme...