[buddypress-trac] [BuddyPress] #5031: Invalid PHPDoc: @return The one true BuddyPress Instance

[buddypress-trac]

#5031: Invalid PHPDoc: @return The one true BuddyPress Instance
--------------------------+-----------------------------
 Reporter:  tivnet        |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  Core          |    Version:  1.7
 Severity:  normal        |   Keywords:  needs-patch
--------------------------+-----------------------------
 `@return` must specify a type. In this case, it's class `BuddyPress`

 A correct way would be:

 {{{

  * @return BuddyPress The one true BuddyPress Instance
  */
 public static function instance() {
 }}}


 and


 {{{
  * @return BuddyPress The one true BuddyPress Instance
  */
 function buddypress() {
         return BuddyPress::instance();
 }

 }}}

 Note also the proper capitalization of `BuddyPress` in the return
 statement.

--
Ticket URL: <https://buddypress.trac.wordpress.org/ticket/5031>
BuddyPress <http://buddypress.org/>
BuddyPress