WordPress.org

Make WordPress Core

Opened 11 years ago

Closed 11 years ago

#5509 closed enhancement (fixed)

PHPdoc effort for pluggable.php

Reported by: darkdragon Owned by: westi
Milestone: 2.5 Priority: low
Severity: minor Version:
Component: Optimization Keywords: phpdoc has-patch commit
Focuses: Cc:

Description

PHPdoc efforts for pluggable.php enhances the inline documentation of the file.

  • Adds @since information
  • Documents deprecated pluggable functions
  • Documents file level for xref and phpdocumentor sites.
  • Adds all functions to WordPress package
  • Has short and long descriptions
  • Documents parameters and return values

Attachments (4)

pluggable.phpdoc.r6473.diff (15.5 KB) - added by darkdragon 11 years ago.
Incomplete documentation for pluggables.php based off of r6473
pluggable.phpdoc.r6582.diff (18.8 KB) - added by darkdragon 11 years ago.
Still incomplete phpdoc based off of 6582
pluggable.phpdoc.r6597.diff (15.1 KB) - added by darkdragon 11 years ago.
Just finished documention for pluggable functions, based off of r6597
pluggable.phpdoc.r6636.diff (12.4 KB) - added by darkdragon 11 years ago.
Completed phpdoc for pluggable.php based on r6636

Download all attachments as: .zip

Change History (13)

@darkdragon
11 years ago

Incomplete documentation for pluggables.php based off of r6473

#1 @darkdragon
11 years ago

If you are wondering what relevance the patch has, most of the work is at the bottom and goes up, since I usually use Zend Studio to document the parameters and return values working down and then add the @since, short/long descriptions going back up.

Description is based on completed documentation, which this the current patch isn't there yet.

#2 @westi
11 years ago

  • Owner changed from anonymous to westi
  • Status changed from new to assigned

#3 @westi
11 years ago

Good work . Won't commit until we have more info

#4 @darkdragon
11 years ago

  • Summary changed from PHPdoc for pluggable.php to PHPdoc effort for pluggable.php

@darkdragon
11 years ago

Still incomplete phpdoc based off of 6582

@darkdragon
11 years ago

Just finished documention for pluggable functions, based off of r6597

#5 @darkdragon
11 years ago

Patch for r6597, just has completed function documentation or as close to complete as possible.

#6 @ryan
11 years ago

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [6600]) phpdoc for pluggable from darkdragon. fixes #5509

#7 @darkdragon
11 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Committed phpdoc comments only covers a small portion of full file, but currently the only ones I have completed or almost completed portions.

It will allow for uploading a new template patch for anyone else who wishes to complete the file to have less work to do.

@darkdragon
11 years ago

Completed phpdoc for pluggable.php based on r6636

#8 @darkdragon
11 years ago

  • Keywords commit added; documentation removed
  • Milestone changed from 2.6 to 2.5

Last patch which completes ticket. All other corrections probably belong in #5611.

#9 @ryan
11 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

(In [6637]) phpdoc for pluggable.php from darkdragon. fixes #5509

Note: See TracTickets for help on using tickets.