Hi all,
I've always PHPDoc syntax in my main code comments, but never actually used it
to output documentation until now.
I've got this snippet of a test block for playing using PHPDoc 1.4 bundled in
Zend Studio 6.1:
/**
* The short description
*
* As many lines of extendend description as you want {...@link element}
* links to an element
*
* In addition, in version 1.2+ one can link to extended documentation like this
* documentation using {...@tutorial phpDocumentor/phpDocumentor.howto.pkg}
* In a method/class var, {...@inheritdoc may be used to copy documentation
from}
* the parent method
*
* @abstract
* @access public
* @author author name <aut...@email>
* @copyright name date
*/
All is well in the output, except the top "Description" area of the generated
doc is empty, and I find all of this info under the "Includes" section. Here's
a shot of what I'm seeing (note the above is a snippet, this looks a touch
different):
http://www.screencast.com/users/Zanzo/folders/Jing/media/91360669-9055-4bdd-8d6d-368ee86a00cc
What am I doing wrong here? I assume the top Description area should be
populated *somehow*.
FYI - I am using the default options for this. No custom tags and all tick
boxes are off.
Cheers
Aaron
--~--~---------~--~----~------------~-------~--~----~
NZ PHP Users Group: http://groups.google.com/group/nzphpug
To post, send email to [email protected]
To unsubscribe, send email to
[email protected]
-~----------~----~----~----~------~----~------~--~---
