Opened 13 months ago

Last modified 6 months ago

#20425 new enhancement

Documentation Issues

Reported by: GaryJ Owned by:
Priority: normal Milestone: Awaiting Review
Component: Inline Docs Version: 3.4
Severity: minor Keywords:
Cc: ipstenu@…, rachelbaker

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 8 months ago.
Updated the docs for credits.php with help from Marko!
0001-Updated-docblocks-for-export.php.patch​ (957 bytes) - added by raggedrobins 8 months ago.
Updated docblocks for export.php

Download all attachments as: .zip

Change History (5)

comment:1   Ipstenu — 13 months ago

  • Cc ipstenu@… added

raggedrobins — 8 months ago

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

raggedrobins — 8 months ago

Updated docblocks for export.php

comment:3   rachelbaker — 6 months ago

  • Cc rachelbaker added
Note: See TracTickets for help on using tickets.