[wp-trac] [WordPress Trac] #29734: Improve inline docs for check_comment()

[WordPress Trac]

#29734: Improve inline docs for check_comment()
--------------------------+-----------------------
 Reporter:  DrewAPicture  |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  4.1
Component:  Comments      |    Version:
 Severity:  normal        |   Keywords:  has-patch
  Focuses:  docs          |
--------------------------+-----------------------
 Need to do:
 * Remove duplication of the 'number of links' phrase in the function
 docblock
 * Format params
 * Add the alternative return of false to the `@return` tag
 * Fix various inline comment syntax

--
Ticket URL: <https://core.trac.wordpress.org/ticket/29734>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform