Code documentation using phpDocumentor

XML, Perl, Python, and other languages can be discussed here, even if it isn't PHP (We might forgive you).

Moderator: General Moderators

Post Reply
User avatar
nielsene
DevNet Resident
Posts: 1834
Joined: Fri Aug 16, 2002 8:57 am
Location: Watertown, MA

Code documentation using phpDocumentor

Post by nielsene »

So I'm just getting started with phpDocumentor; some of its limitations are slightly annoying. I was wondering what people have found as decent solutions:

Problems:
1. They use @package and @subpackage tags to help organize files/classes into namespces/etc. Only the two levels of hierarchy are provided. It looks like standard practice is to put everything into one top level package.... This then leave only a very flat/broad topography for other aspects. I've been looking at using multiple top-level packages (Command_Line_Scripts,Web_Pages,Infrastructure) and then some below, or using the logical modules that the code is already subdivided into as packagess. Both are OK. I'ld still like a third level at least though.

2. Outside packages. I use the simpletest framework for writing test cases. Thus all my test case classes exten the simpletest classes. If I don't include the simpletest code tree in my "directories to document" list it throughs up lots of warnings and such. I can include the directory in the list, but then you end up with a "Simpletest" top level package that might look like its actually part of my project. If I had fewer top level pacakges, then its less of a problem and easier to make it clear that only "CompInaBox" is the project, other top levels are only included third-party modules, etc.

Anyone have any experience with solving these issues?
User avatar
nielsene
DevNet Resident
Posts: 1834
Joined: Fri Aug 16, 2002 8:57 am
Location: Watertown, MA

Post by nielsene »

Now a third rather major problem:

3. I have a growing number of extenionless scripts using ForceType to cause Apache to invoke PHP, allowing
http://example.net/foo/sec1/page3 instead of say
http://example.net/foo.php?sec=sec1&page=page3 without using mod_rewrite messiness. However phpDocumentor won't pick up extensionless files and I can't seem to find any flags/options to help make it look at those files. I don't want to add extensioned symlinks. Any other suggestions before I try hacking the source code for phpDocumentor?
Post Reply