[PEAR] How to document folders and other file types with phpDocumentor

On 4/25/07, Seyyed Sina Salek <sinasalek@gmail.com> wrote:
>
> Hi, thanks for the complete answer
> I see that documentation of phpDocumentor has custom section "*
> Tutorials/Manuals:* *Package-level:*" in the left side menu.
> There is not enough information about how to implement it to the
> documentation.
> If i can implement it, i can make a tree of folder structure and put it at
> left menu as a structure guide.
> Do you know any useful tutorial?
>
> Regards
>


Try this link for info on building tutorials in your code:
http://manual.phpdoc.org/HTMLSmartyC...rials.pkg.html

I've only done this myself at the very minimum, as a starting point to
building some tutorials for an existing application I support. To mimic my
tiny beginning, start with this structure in the top-level folder of your
code you want to document:

-- ./MyApp/
(your top-level dir)

-- ./MyApp/tutorials/
(all tutorial docs belong here)

-- /MyApp/tutorials/MyApp/
(if this name perfectly matches your @package tag's value,
then phpDoc knows to align it with that package in the
output docs)

-- /MyApp/tutorials/MyApp//MyApp.pkg
(you must have a PKG file that matches the parent dir...
this forms the top level of the tutorial doc hierarchy)

That minimal start seems to be good enough to make phpDocumentor recognize
you have tutorial docs you want generated. Follow the info at that link
above on how to populate the PKG file, and you can then test phpDocumentor
against just those pieces to verify you've constructed it properly. After
that, you can start adding additional files as needed.
CRB