Re: I would like to write an RFC for the addition of an internal keyword

From: Date: Wed, 27 Feb 2013 17:37:05 +0000
Subject: Re: I would like to write an RFC for the addition of an internal keyword
References: 1 2 3 4  Groups: php.internals 
Request: Send a blank email to [email protected] to get a copy of this message 
On 2/27/13 10:22 AM, Sebastian Krebs wrote:

2013/2/27 Steve Clay <[email protected]>

phpDoc already supports "@access private" for items to be left out of
public documentation. An IDE could be configured to have these items appear
greyed or not to appear in autocomplete lists.



a) You misuse the "private visibility" here: "@access private" comes from
old PHP4-days, where the DocComment must know the visibility, because the
method itself didn't


Sure, but phpDocumentor1 currently uses @access to control documentation output (the description doesn't mention access/visibility at all and "protected" does nothing).
http://manual.phpdoc.org/HTMLSmartyConverter/default/phpDocumentor/tutorial_tags.access.pkg.html

For phpDoc2 the OP should also check out these:
http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/internal.html
http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/api.html
http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/ignore.html

Steve Clay
-- 
http://www.mrclay.org/

Thread (16 messages)

« previous php.internals (#66282) next »