WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 4 years ago

Last modified 4 years ago

#20425 closed enhancement (fixed)

Documentation Issues

Reported by: GaryJ Owned by: DrewAPicture
Milestone: 3.7 Priority: normal
Severity: minor Version: 3.4
Component: Inline Docs Keywords:
Focuses: Cc:

Description

New ticket as per Nacin's request.

http://docs.garyjones.co.uk/wordpress/3.4-beta1/errors.html shows the documentation errors (missing / incorrect arguments @param tags, missing short descriptions, missing DocBlocks at the file-level and structural element level etc.) when run against 3.4-beta1.

It doesn't include things like missing @since tags, version numbers not always being 3 digits, or some other bits, but getting the listed 2693 errors fixed would be a great start to a more complete API documentation.

Attachments (2)

0001-Updated-docs-for-credits.php.patch (1.5 KB) - added by raggedrobins 5 years ago.
Updated the docs for credits.php with help from Marko!
0001-Updated-docblocks-for-export.php.patch (957 bytes) - added by raggedrobins 5 years ago.
Updated docblocks for export.php

Download all attachments as: .zip

Change History (8)

#1 @Ipstenu
5 years ago

  • Cc ipstenu@… added

@raggedrobins
5 years ago

Updated the docs for credits.php with help from Marko!

@raggedrobins
5 years ago

Updated docblocks for export.php

#3 @rachelbaker
5 years ago

  • Cc rachelbaker added

#4 @DrewAPicture
4 years ago

In 25490:

Add missing phpdoc block for export_date_options().

Props siobhan for the initial patch. See #20425

#5 @DrewAPicture
4 years ago

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

In 25491:

Add phpdoc blocks in wp-admin/credits.php.

Props siobhan, markoheijnen.
Fixes #20425.

#6 @DrewAPicture
4 years ago

  • Milestone changed from Awaiting Review to 3.7
Note: See TracTickets for help on using tickets.