Re: Documention problems
| From: | (Stig Sæther Bakken) | Date: | Fri, 10 Aug 2001 14:11:05 +0000 |
| Subject: | Re: Documention problems | ||
| References: | 1 2 3 4 5 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-1372@lists.php.net to get a copy of this message | ||
[Chuck Hagenbuch <chuck@horde.org>]
> Quoting "Stig S. Bakken" <ssb@alltheweb.com>:
>
> > The term "package" has a defined meaning in PEAR, and it's different
> >from Java. We should care about implementing PHP/PEAR semantics in
> >PHPDoc, not drag around this Java ball-and-chain legacy that does not
> >fit us. Forcing every class in a package to inherit a class with the
> >same name as the package is just wrong.
>
> Whoa, whoa, whoa! That's wrong in Java, also! It just denotes
> directory structure. Everything in the org.horde package, for example,
> needs to live inside org/horde/. I don't know where the concept of
> everything needing to inherit came in, but that's completely
> inaccurate from a java standpoint - package foo can have foo.Batman
> that just inherits from Object; in fact, there doesn't even have to be
> a class Foo for other things in package foo to inherit from!
>
> Now, the directory structure of the PEAR cvs tree makes this
> confusing, and is probably what breaks phpDoc (I've missed some of the
> discussion). Personally, I think it would make sense to have things
> organized in the cvs tree how they'd be installed, but this way makes
> sense also. So if I'm understanding everything correctly, we just need
> to run phpdoc on a set of checkouts that mirror the install directory
> structure, instead of the straight tree?
Maybe, but for a long-term solution I think we should re-write the
documentation tool to cope with how people work, rather than the other
way around. :-)
> Slightly confused and hoping to clear up some misconceptions, -chuck
Remember that there will be PEAR packages that don't use the CVS
repository at all.
- Stig
--
Stig Sæther Bakken <ssb@alltheweb.com>
Fast Search & Transfer ASA, Trondheim, Norway