phpDocumentor development
| From: | Greg Beaver | Date: | Wed, 29 Jan 2003 05:42:08 +0000 |
| Subject: | phpDocumentor development | ||
| Groups: | php.pear.dev php.pear.doc | ||
| Request: | Send a blank email to pear-dev+get-12798@lists.php.net to get a copy of this message | ||
Hi all,
We've implemented all of Darren Cook's excellent suggestions, which included
last week's mention of @example, @filesource, etc., and the latest is a
separate page of @todo tags pulled from the documentation. This will allow
centralized tracking of what is left to change in the project. For public
documentation, a simple --ignoretag @todo will avoid creating the page, if
desired.
We've also fixed a number of bugs, and implemented Christian Dickmann's
request for converter params. A restructuring of Converters will occur for
the next beta, I've realized that many things can and should be moved to the
Converter class, so that the complexity of child classes (like
HTMLframesConverter) are not as formidable. This should cut down on coding
time and bugs for those who need added functionality.
I've done a bit of work on the CHM converter, and an example help file is
available at http://phpdoc.org/docs, just click on the
CHM:default:default
link
The last major tasks include getting the peardoc2 templates to be worth
anything, and finishing documentation. I am trying to get the documentation
close to finished, and then will be looking into finishing up peardoc2.
The move of code from child converters to the base class will definitely
make updating code easier, and should reduce the overall size of
phpDocumentor tremendously. I am also planning on reworking the way
indexing is done so that there isn't a massive switch, and more of the work
of formatting is done in templates. In addition, indexing will be performed
by the base class to the extent that is possible. This style shift will be
obvious when it is completed, and probably one of those "why didn't they do
this earlier?" kind of things :)
Take care,
Greg
--
phpDocumentor
http://www.phpdoc.org