2015-09-09 2 views
0

Y a-t-il un moyen de configurer phpdoc afin qu'il génère également des documents pour toutes les applications de fournisseurs installées avec composer?Comment intégrer les documents du fournisseur dans phpdoc?

Pourquoi? Eh bien, parce que ce serait très agréable d'avoir un seul environnement de documentation qui fournit à tous les docs la version actuelle de votre application et toutes les applications de votre fournisseur. Vous pouvez juste chercher votre propre environnement de document pour vérifier comment vous devriez parler à un objet appartenant à Laravel ou Zend ou tout ce dont vous avez besoin.

Mon phpdoc.xml actuelle ressemble à ceci:

<?xml version="1.0" encoding="UTF-8" ?> 
<phpdoc> 
    <title>App title</title> 
    <parser> 
     <default-package-name>RootNamespace\app\</default-package-name> 
     <target>docs</target> 
     <markers> 
      <item>TODO</item> 
      <item>FIXME</item> 
     </markers> 
     <extensions> 
      <extension>php</extension> 
      <extension>php3</extension> 
      <extension>phtml</extension> 
     </extensions> 
     <visibility></visibility> 
    </parser> 
    <transformer> 
     <target>docs</target> 
    </transformer> 
    <logging> 
     <level>warn</level> 
     <paths> 
      <default>{APP_ROOT}/data/log/{DATE}.log</default> 
      <errors>{APP_ROOT}/data/log/{DATE}.errors.log</errors> 
     </paths> 
    </logging> 
    <files> 
     <ignore>src/View/*</ignore> 
     <ignore>tests/*</ignore> 
     <directory>src</directory> 
    </files> 
</phpdoc> 

S'il vous plaît ne pas répondre avec juste "Non". Quelqu'un a dû comprendre cela.

+1

Si l'on suppose votre 'phpdoc.xml' est dans votre haut niveau répertoire, je pense: ' fournisseur/**/* fournisseur/bin fournisseur/compositeur' – bishop

Répondre

1

Le Commentaire de @bishop a fonctionné pour moi:

En supposant que votre phpdoc.xml est dans votre répertoire de niveau supérieur, puis cela fonctionne:

<files> 
    <directory>vendor/**/*</directory> 
    <directory>src</directory> 
    <ignore>vendor/bin</ignore> 
    <ignore>vend‌​or/composer</ignore> 
    <ignore>src/View/*</ignore> 
    <ignore>tests/*</ignore> 
</files> 
+0

Comment cela peut-il être fait dans le sens inverse; ignorer tous les répertoires des fournisseurs sauf certains, plutôt que d'ignorer certains d'entre eux? –