Ticket #5444 (closed enhancement: fixed)

Opened 4 years ago

Last modified 4 years ago

PHPdoc effort for deprecated.php

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

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

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

Change History

darkdragon — 4 years ago

Documentation for deprecated.php based off of r6367

comment:1   darkdragon — 4 years ago

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

comment:2   ryan — 4 years ago

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

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

comment:3   darkdragon — 4 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.