phpDocumentor: classes uniquement document

J'essaie d'en savoir plus sur phpDocumentor. Je mets généralement une classe par fichier. Suis-je obligé de documenter le fichier et les cours? Je veux juste documenter les classes (Pourquoi devrais-je documenter les fichiers?) Mais je recevoir des avertissements ...phpDocumentor: classes uniquement document

WARNING in comment.class.php on line 8: DocBlock would be page-level, but precedes class "Comment", use another DocBlock to document the file

J'ai lu http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html.

Merci

Source

2010-10-11 thomas

Vous ne devez pas documenter le fichier, il est juste un avertissement. Si vous ne mettez pas de doc au niveau du fichier, il n'y aura pas d'informations sur la liste des "fichiers" phpdoc, même s'il y en aura pour la liste "class".

Source

2010-10-11 14:04:45

N'existe-t-il aucun moyen de ** supprimer ** ces avertissements? – Nathaniel

@NatIsGleek Pourquoi avez-vous besoin de les supprimer? Lorsque vous exécutez le script php documentor, vous pouvez router la sortie d'erreur vers '/ dev/null' –

Les fichiers apparaissent toujours dans la liste bien que ... –

phpDocumentor: classes uniquement document

Répondre

Questions connexes