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

[WordPress Trac]

#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:  needs-patch
--------------------------+-------------------------------------------------

Comment(by nacin):

 How's this for a boilerplate template. My comments to the comments are
 after #.
 {{{
 /**
  * A one-line description of the function
  *
  * A longer description of the plugin. This can span multiple lines.
  * Also might not be necessary. Lorem ipsum.
  * Lorem ipsum.
  *
  * And multiple paragraphs.
  * Lorem ipsum.
  *
  * @since MU # or 3.0.0 etc.
  * @access private # if it is an internal function
  *
  * @param string $argument_name This argument does blah.
  * @param array $args This accepts a whole bunch of args:
  *  - blah_id: The id of the blah. Defaults to false, which means no ID is
 used.
  *  - foo: The foo. Very important. Defaults to an empty string.
  * @param bool $optional_argument Optional. Default true. This argument
 does blah.
  * @return array Returns an array of blah.
  */
 function my_function( $argument_name, $args = array(), $optional_argument
 = true ) {
     // Blah
 }
 }}}

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