Basic help question about getting started

[email protected] ("Michael Jackson")
Newsgroups php.pear.doc
Message-ID <[email protected]>
Hello,

I have a very simple package that I'd like to contribute to the PEAR
repository, and I'm trying to write up some docs before I submit a proposal.
I read the PEAR manual chapter on writing documentation and I still have a
few questions. For example, after running:

 phpdoc -p on -f /path/to/my/package/source/File.php -t . -o
"XML:DocBook/peardoc2:default" -dc myPackageCategory

on my code, I get a large number of files (one for each method) plus a few
others for classes, constants, etc. However, when I go to look at some
sample documentation (HTTP_Request for example) I see only 8 files - one for
each page of the end-user documentation in the PEAR manual. So my question
is, which of these am I supposed to use?

I'm assuming that I'm supposed to do the documentation in the latter style,
because the former appears to just be API documentation that can
automatically be generated with each new release. However, I'd like a little
clarification before I start digging into this project.

Thanks!

Michael Jackson
[email protected]
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.