[wp-trac] [WordPress Trac] #21303: class-wp-customize-*.php files inline documentation

[WordPress Trac]

#21303: class-wp-customize-*.php files inline documentation
-----------------------------+------------------
 Reporter:  bananastalktome  |       Owner:
     Type:  enhancement      |      Status:  new
 Priority:  normal           |   Milestone:  3.5
Component:  Inline Docs      |     Version:
 Severity:  trivial          |  Resolution:
 Keywords:  has-patch        |
-----------------------------+------------------

Comment (by nacin):

 Replying to [comment:7 scribu]:
 > Are @access keywords really necessary when there's an explicit keyword
 present in the code?

 Good question. I don't see them documented anywhere on the
 [http://www.phpdoc.org/docs/latest/index.html phpdoc 2 site]. I do know
 that @access private prevents documentation from being generated (unless a
 flag is set on generation), which is very helpful for hiding our many
 internal functions from phpdoc output. But it's definitely possible that
 it was removed on the basis of PHP5 visibility keywords.

 That said, we should still use them especially in our pre-3.2 classes,
 where we might have a "private" variable or function that, for
 compatibility reasons, we can't mark with a visibility keyword. In these
 cases, I have avoided marking these functions as explicitly "public," and
 I've left should-be variables as "var".

-- 
Ticket URL: <http://core.trac.wordpress.org/ticket/21303#comment:8>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software