[wp-trac] [WordPress Trac] #14953: Add inline documentation to MultiSite functions

WordPress Trac wp-trac at lists.automattic.com
Thu Sep 30 19:35:00 UTC 2010

#14953: Add inline documentation to MultiSite functions
 Reporter:  scribu        |       Owner:           
     Type:  defect (bug)  |      Status:  new      
 Priority:  normal        |   Milestone:  3.1      
Component:  Inline Docs   |     Version:  3.0      
 Severity:  normal        |    Keywords:  has-patch

Comment(by jacobsantos):

 Replying to [comment:21 scribu]:
 > Replying to [comment:19 scribu]:
 > > We should remove all those @uses because:
 > >  * they get stale really fast
 > >  * you can get that information by using PHPXref or just looking at
 the source
 > As the Codex says, @uses should only be used for globals, like $wpdb.

 The codex does not say that. It also wouldn't be true in any case. The
 only reason the @uses would be stale is if there were modifications to the
 code without updating the inline documentation.

 Using a separate application takes away from the reasons behind
 phpdocumentor sites. I would say that only functions that provide more
 information on the usage of the function should be linked with {{{@uses}}}
 as some functions and methods are helpers for other functions.

Ticket URL: <http://core.trac.wordpress.org/ticket/14953#comment:22>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software

More information about the wp-trac mailing list