[wp-trac] [WordPress Trac] #23914: Document WP_Dependencies

WordPress Trac noreply at wordpress.org
Sat Sep 7 17:23:36 UTC 2013


#23914: Document WP_Dependencies
-------------------------+------------------
 Reporter:  kitchin      |       Owner:
     Type:  enhancement  |      Status:  new
 Priority:  normal       |   Milestone:  3.7
Component:  Inline Docs  |     Version:
 Severity:  normal       |  Resolution:
 Keywords:  has-patch    |
-------------------------+------------------

Comment (by DrewAPicture):

 [attachment:class.wp-dependencies.php.patch] is a good starting point,
 though there's a lot more work to be done.

 * [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#2-class-properties Properties] need to be
 documented
 * [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-1-parameters-that-are-arrays Array
 parameters] need to be documented
 * All methods need [http://make.wordpress.org/core/handbook/inline-
 documentation-standards/php-documentation-standards/#1-functions-and-
 class-methods x.x.x]-style versions
 * [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-functions-and-class-methods Short
 descriptions] need periods

 I'll have an incremental patch shortly to help these tasks along.

 Also, we'll need to document any [http://make.wordpress.org/core/handbook
 /inline-documentation-standards/php-documentation-standards/#4-hooks-
 actions-and-filters hooks or filters] though that's probably best left to
 the hooks/filters effort going on over in #25229.

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


More information about the wp-trac mailing list