CODEWITHSUNDEEP
phpdocumentationdocumentphpdoc
thomas
thomas

Reputation: 41

phpDocumentor: document only classes

I'm trying to learn about phpDocumentor. I usually put a classe per file. Am I forced to document file and classes? I want to document just classes (Why should i document files?) but i receive warnings...

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

I've read http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html.

Thank you

Upvotes: 4

Views: 1406

Answers (1)

Explosion Pills
Explosion Pills

Reputation: 191809

You don't have to document the file, it's just a warning. If you don't put a file-level doc, then there will be no information on the phpdoc "files" list, even though there will be some for the "class" list.

Upvotes: 1

Related Questions