Re: @access - newbie question
| From: | Greg Beaver | Date: | Thu, 02 Jan 2003 19:37:51 +0000 |
| Subject: | Re: @access - newbie question | ||
| References: | 1 2 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-3146@lists.php.net to get a copy of this message | ||
phpDocumentor's handling of @access is pretty non-committal with the
assumption that PHP 5.0 will be rigid in its definition of access.
Obviously, once access is hard-coded into objects, the @access tag will be
irrelevant. What phpDocumentor does with @access is assume that any @access
private objects are low-level and possibly confusing for the purpose of
documenting a package for users to use. In other words, when generating
user-level API docs, extra, confusing information is filtered out by
default. To change this, either remove the @access tag (or specify @access
protected/public, @access is public by default) or parse with
the --parseprivate command-line.
Take care,
Greg
--
phpDocumentor
http://www.phpdoc.org
"Shane Antyr" <santyr@macosx.com> wrote in message
news:7F82FCA7-1470-11D7-87DE-000393864F82@macosx.com...
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> Thanks again. I'm looking over the phpDocumentor documentation now.
> - -S
>
> On Friday, December 20, 2002, at 04:07 PM, Jesus M. Castagnetto wrote:
>
> >
> > --- Shane Antyr <santyr@macosx.com> wrote:
> >
> >> Thanks Jesus.
> >>
> >> I was aware that it was for documentation., but was wondering what
> >> made
> >> it public or private. So if I read you correctly your saying private
> >> does not apply at this point ( all @access is public?)
> >
> > Yep, in PHP 4 at least, marking something as private in the
> > documentation is
> > more a warning/suggestion for the users of your code. There is not
> > enforcenment
> > from the part of the interpreter. That might (or will) change once
> > Zend 2 gets
> > finishes as it will have more object oriented characteristics so
> > private,
> > public, static, etc. will have the regular meaning and enforcenment as
> > other
> > OOP languages.
> >
> >>
> >> On Friday, December 20, 2002, at 03:11 PM, Jesus M. Castagnetto
> >> wrote:
> >>
> >>> There are no 'private' methods/attributes as such in PHP 4, there
> >>> will
> >>> (might?)
> >>> be in PHP 5
> >
> >
> > =====
> > --- Jesus M. Castagnetto (jcastagnetto@yahoo.com)
> >
> > Research:
> > http://metallo.scripps.edu/
> > Personal: http://www.castagnetto.org/
> >
> > __________________________________________________
> > Do you Yahoo!?
> > Yahoo! Mail Plus - Powerful. Affordable. Sign up now.
> > http://mailplus.yahoo.com
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.2.1 (Darwin)
>
> iD8DBQE+A6PemU+jltT1nOoRAk75AJ9DOQTBm+JqUimNF1AiOSsSRKjUdgCcD91A
> kiKg8jhYPI57eIO5wFR3C9s=
> =rDEv
> -----END PGP SIGNATURE-----
>