StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

PO
text
Body
copied!<p>phpDocumentor itself does not have a native option to handle this use case. What I've done in the past has been to create a dummy file that contains empty class declarations for all the "not found" classes, tagged these classes like "@package DoNotDocument", and used the runtime --packageoutput argument [1] <em>without</em> listing "DoNotDocument" in the list of packages to include in the output documents. Granted, this is a hack, but the effect is to:</p> <p>a) avoid "not found" warnings (because class now "exists"),</p> <p>while b) not creating any docs for the dummy classes.</p> <pre><code>/** * @package DoNotDocument */ class Zend_Controller_Action {} phpdoc -d ./src -t ./docs -po MyPackage1,MyPackage2 </code></pre> <p>Now, something to ponder regarding your docs, if your classes do indeed extend ZF classes. By not having phpDocumentor parse those ZF sources, your API docs for your classes will not show what methods etc that are inherited from those ZF parents. If this was my code base, I would allow phpDocumentor to parse the ZF files, but would avoid having the ZF classes documented by <em>not</em> listing their inherent @package value (e.g. "Zend_Controller") in the runtime --packageoutput argument.</p> <p>[1] -- <a href="http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.packageoutput" rel="nofollow">http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.packageoutput</a></p>

Querying!

Guidance

An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload