Skip to:
Content

BuddyPress.org

Opened 6 years ago

Closed 5 years ago

#6398 closed enhancement (fixed)

BP-Core documentation cleanup.

Reported by: tw2113 Owned by: tw2113
Milestone: Priority: normal
Severity: normal Version:
Component: Core Keywords:
Cc:

Description

This ticket will be a placeholder for commits and changes related to cleaning up phpdoc blocks and inline comments in BuddyPress core. These changes will focus on cleaning up things like return types, parameter inaccuracies, parameter explanation expansion and explanation of what is going on at any given point in the codebase.

Change History (11)

#1 @tw2113
6 years ago

In 10012:

First pass at BP-Core docs cleanup.

See #6398.

#2 @tw2113
5 years ago

In 10039:

More updates to BP-Core docs.

See #6398.

#3 @tw2113
5 years ago

In 10052:

Punctuation cleanup for core files.

See #6398.

#4 @tw2113
5 years ago

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

#5 @tw2113
5 years ago

In 10354:

More documentation cleanup for part of BP-Core component.

See #6398.

#6 @tw2113
5 years ago

In 10355:

More documentation cleanup for part of BP-Core component.

See #6398.

#7 @tw2113
5 years ago

In 10356:

[Samus Aran]
I first battled the documentation inconsistencies on planet Zebes. It was there that I foiled the plans of the
Space Pirate leader Mother Brain to use the issues to attack galactic civilization...

I next fought the inconsistencies on their homeworld SR388. I completely eradicated them except for an @since tag,
which after hatching followed me like a confused child...

I personally delivered it to the Galactic Research Station at Ceres so scientists could study its energy production qualities...

The scientists' findings were astounding! They discovered that the powers of the docs inconsistencies
might be harnessed for the good of galactic civilization!

Satisfied that all was well, I left the station to seek a new bounty to hunt. But, I had hardly gone beyond the asteroid
belt when I picked up a distress signal!

Ceres station was under attack!

More documentation cleanup for part of BP-Core component.

See #6398.

#8 @tw2113
5 years ago

In 10425:

Scrutinizr feedback cleanup.

See #6398.

#9 @tw2113
5 years ago

In 10497:

Adds many missing @since tags to the BP Core component.

See #6398.

#10 @tw2113
5 years ago

In 10899:

Many PHPDocs cleanup for Core component.

See #6398.

#11 @tw2113
5 years ago

  • Milestone Future Release deleted
  • Resolution set to fixed
  • Status changed from assigned to closed
Note: See TracTickets for help on using tickets.