WordPress.org

Make WordPress Core

Opened 12 years ago

Closed 12 years ago

Last modified 12 years ago

#5444 closed enhancement (fixed)

PHPdoc effort for deprecated.php

Reported by: darkdragon Owned by:
Milestone: 2.5 Priority: low
Severity: trivial Version: 2.5
Component: General Keywords: deprecated.php phpdoc has-patch commit
Focuses: Cc:
PR Number:

Description

Over the discussion in WP-Hackers and the lack of alternatives in the wp-includes/deprecated.php. I went ahead and documented all of the globals and functions in that file.

The patch also cleans up some coding standard violations in the file. Not a lot of time was spent obtaining or adding parameter information (that didn't already exist) and adding long and short descriptions if they didn't exist before. This is intentional.

There is no point spending more time than needed to document functions that probably won't be used any longer. However, @since tags and alternatives has been added to every function.

Attachments (1)

deprecated.phpdoc.diff (39.1 KB) - added by darkdragon 12 years ago.
Documentation for deprecated.php based off of r6367

Download all attachments as: .zip

Change History (4)

@darkdragon
12 years ago

Documentation for deprecated.php based off of r6367

#1 @darkdragon
12 years ago

  • Cc deprecated.php phpdoc has-patch commit removed
  • Keywords deprecated.php phpdoc has-patch commit added

#2 @ryan
12 years ago

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

(In [6370]) phpdoc for deprecated funcs. Props darkdragon. fixes #5444

#3 @darkdragon
12 years ago

  • Summary changed from PHPdoc for Deprecated functions and globals to PHPdoc effort for deprecated.php
Note: See TracTickets for help on using tickets.