Hello,
I'd like to document a PHP homemade framework. I wrote a DocBlock at the top
of each class, like this:
-------------------------------------------------------------------------------------
/*
* Brief description of my class
*
* Detailed description
*
* @author Michael Courtier<mic...@gm...>
* @package html
*
*/
class HTML_Element {
...
}
-------------------------------------------------------------------------------------
I generate the documentation in XML.
in index.xml, the main file generated which sums up the whole framework, I
can see my "html" package in this xml document :
<compound refid="d5/d71/namespacehtml"
kind="namespace"><name>html</name></compound>
I assume the @package attribute is in the right DocBlock. But now, in my
detailed xml file (the one for the class HTML_Element), the brief
description and detailed description nodes are empty !!
if I delete the @package attribute, then it works, and I have the brief and
detailed description in my xml file. Am I documenting this class correctly ?
Sincerely
Michael Courtier
|
