Skip to:
Content

BuddyPress.org

Opened 3 years ago

Last modified 3 years ago

#7377 accepted enhancement

Inline documentation improvements for 2.8

Reported by: slaFFik Owned by: tw2113
Milestone: Awaiting Contributions Priority: low
Severity: minor Version:
Component: Core Keywords:
Cc:

Description (last modified by slaFFik)

There are bunch of places, where PHPDoc is not synced with the related doc.
Example:

/**
 * Render the Group Type metabox.
 *
 * @since 2.6.0
 *
 * @param BP_Groups_Group|null $user The BP_Groups_Group object corresponding to the group being edited.
 */
function bp_groups_admin_edit_metabox_group_type( BP_Groups_Group $group = null ) {}

Note the usage of $user in @param and $group in code. This might be a problem later, when we will start using https://developer.buddypress.org by @tw2113, so it's better to fix earlier.

The goal of this task is to make constant improvements in such places in various parts of the BuddyPress code.

Change History (4)

#1 @slaFFik
3 years ago

  • Description modified (diff)

#2 @tw2113
3 years ago

  • Owner set to tw2113
  • Status changed from new to accepted

#3 @slaffik
3 years ago

In 11289:

Inline documentation: bp-core-attachments.php

Improved inline documentation in phpdoc for several functions.

See #7377.

#4 @DJPaul
3 years ago

  • Milestone changed from 2.8 to Future Release
Note: See TracTickets for help on using tickets.