[wp-trac] [WordPress Trac] #25393: Hook Docs: wp-login.php

[WordPress Trac]

#25393: Hook Docs: wp-login.php
-------------------------+---------------------------
 Reporter:  ShinichiN    |       Owner:  DrewAPicture
     Type:  enhancement  |      Status:  closed
 Priority:  normal       |   Milestone:  3.7
Component:  Inline Docs  |     Version:
 Severity:  normal       |  Resolution:  fixed
 Keywords:  has-patch    |
-------------------------+---------------------------

Comment (by DrewAPicture):

 Replying to [comment:13 tivnet]:
 > Replying to [comment:12 DrewAPicture]:
 >
 > The docblock applies @param int to the $user_data for the code following
 it.
 >
 > In general, this use of docblocks is illegal, according to
 >
 > http://www.phpdoc.org/docs/latest/for-users/phpdoc/basic-syntax.html
 #which-elements-can-have-a-docblock
 >
 > So, why not to keep is as just comments, without docblock @-isms? Using
 @s will only disturb phpdocumentor, IMO.

 We use a [http://make.wordpress.org/core/handbook/inline-documentation-
 standards/php-documentation-standards/ customized documentation schema]
 that draws inspiration from phpdoc but doesn't follow it to a tee. A
 notable difference, for instance, is that phpdoc doesn't provide any
 support for an action and filter-driven architecture, such as !WordPress
 is.

 The style of documentation you see here for actions and filters is
 consistent with, and adheres to, the standards outlined in the document
 linked above.

 If you'd like to join the discussion, the inline-docs team meet weekly in
 #wordpress-sfd on Freenode, at 18:00 UTC.

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