Commit Graph

20 Commits

Author SHA1 Message Date
Gary Pendergast aaf99e6913 Code is Poetry.
WordPress' code just... wasn't.
This is now dealt with.

Props jrf, pento, netweb, GaryJ, jdgrimes, westonruter, Greg Sherwood from PHPCS, and everyone who's ever contributed to WPCS and PHPCS.
Fixes #41057.


Built from https://develop.svn.wordpress.org/trunk@42343


git-svn-id: http://core.svn.wordpress.org/trunk@42172 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-11-30 23:11:00 +00:00
John Blackbourn 4a16295dc5 Docs: Standardise the format used for documenting parameters passed by reference.
See #35974, #41017

Built from https://develop.svn.wordpress.org/trunk@41688


git-svn-id: http://core.svn.wordpress.org/trunk@41522 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-10-02 22:14:46 +00:00
Drew Jaynes 0860bb2771 Docs: Remove `@access` notations from method DocBlocks in wp-includes/* classes.
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.

Built from https://develop.svn.wordpress.org/trunk@41162


git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-07-27 00:41:44 +00:00
Sergey Biryukov eb9cc0c13e I18N: Add translator comments for strings in `wp-includes/class-walker-comment.php`.
Merge two similar strings.

Props ramiy.
Fixes #37796.
Built from https://develop.svn.wordpress.org/trunk@38342


git-svn-id: http://core.svn.wordpress.org/trunk@38283 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-08-23 23:33:28 +00:00
Scott Taylor 5efc557eb8 Comments: pass `$comment` to `comment_text()` in `Walker_Comment::comment()` instead of using a function which can skip the cache.
Props rachelbaker.
Fixes #35433.

Built from https://develop.svn.wordpress.org/trunk@37325


git-svn-id: http://core.svn.wordpress.org/trunk@37291 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-04-29 15:47:27 +00:00
Drew Jaynes 0fb5b43307 Docs: Normalize `Walker_Comment` method parameter docs spacing following [37051].
See #36300.

Built from https://develop.svn.wordpress.org/trunk@37052


git-svn-id: http://core.svn.wordpress.org/trunk@37019 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-22 17:46:27 +00:00
Drew Jaynes 69eeedabf9 Docs: Comment display element object types for `Walker_Comment` are `WP_Comment` since 4.4.0.
See #36300.

Built from https://develop.svn.wordpress.org/trunk@37051


git-svn-id: http://core.svn.wordpress.org/trunk@37018 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-22 17:44:25 +00:00
Drew Jaynes 7e65fe4f5b Docs: Improve inline documentation syntax for `Walker_Comment`.
* Marks optional parameters as such
* Improves existing parameter descriptions for clarity
* Syntax improvements

See #36300.

Built from https://develop.svn.wordpress.org/trunk@37050


git-svn-id: http://core.svn.wordpress.org/trunk@37017 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-22 17:41:27 +00:00
Drew Jaynes c4c26e4766 Docs: Standardize the class DocBlock summary for `Walker_Comment`.
See #36300.

Built from https://develop.svn.wordpress.org/trunk@37049


git-svn-id: http://core.svn.wordpress.org/trunk@37016 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-22 17:36:26 +00:00
Drew Jaynes 7b48765674 Docs: Improve inline documentation for properties and methods in `Walker_Comment`.
Props raimy for the initial patch.
See #36300.

Built from https://develop.svn.wordpress.org/trunk@37048


git-svn-id: http://core.svn.wordpress.org/trunk@37015 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-22 17:34:25 +00:00
Drew Jaynes 0fbe903434 Docs: Document the `$id` parameter for `Walker_Comment::start_el()`, which is implemented by `Walker` but unused in the subclass method.
See #32246.

Built from https://develop.svn.wordpress.org/trunk@35927


git-svn-id: http://core.svn.wordpress.org/trunk@35891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-14 17:50:26 +00:00
Scott Taylor 00ade45fd1 Docs: some `@global object` vernaculars should be converted to the actual object type.
See #33491.

Built from https://develop.svn.wordpress.org/trunk@35013


git-svn-id: http://core.svn.wordpress.org/trunk@34978 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-10 15:45:25 +00:00
Drew Jaynes e89737ccfb Docs: Fix wrapping and syntax for a multi-comment in `Walker_Comment::display_element()`.
See #32246.

Built from https://develop.svn.wordpress.org/trunk@34993


git-svn-id: http://core.svn.wordpress.org/trunk@34958 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-09 21:03:25 +00:00
Drew Jaynes e38a6edc61 Docs: Indent an example comment tree in the DocBlock for `Walker_Comment::display_element()` so it can be properly parsed in Markdown for the Code Reference.
See #32246.

Built from https://develop.svn.wordpress.org/trunk@34992


git-svn-id: http://core.svn.wordpress.org/trunk@34957 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-09 21:00:27 +00:00
Drew Jaynes 8df8fb6046 Docs: The Comment API is singular.
See #33701.

Built from https://develop.svn.wordpress.org/trunk@34409


git-svn-id: http://core.svn.wordpress.org/trunk@34373 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-22 13:43:25 +00:00
Scott Taylor db4f22bfb5 After [33961], pass `$comment` to `get_comment_link()` where possible to avoid extra cache/db lookups.
See #33638.

Built from https://develop.svn.wordpress.org/trunk@34042


git-svn-id: http://core.svn.wordpress.org/trunk@34010 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-11 06:21:25 +00:00
Scott Taylor c3f642bea9 After [33961], pass `$comment` to `get_comment_date()` where possible to avoid extra cache/db lookups.
See #33638.

Built from https://develop.svn.wordpress.org/trunk@34041


git-svn-id: http://core.svn.wordpress.org/trunk@34009 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-11 06:15:24 +00:00
Scott Taylor 58c3c30e8d After [33961], pass `$comment` to `comment_class()` where possible to avoid extra cache/db lookups.
See #33638.

Built from https://develop.svn.wordpress.org/trunk@34040


git-svn-id: http://core.svn.wordpress.org/trunk@34008 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-11 06:12:24 +00:00
Scott Taylor fc328f5484 After [33961], pass `$comment` to `get_comment_author_link()` where possible to avoid extra cache/db lookups.
See #33638.

Built from https://develop.svn.wordpress.org/trunk@34039


git-svn-id: http://core.svn.wordpress.org/trunk@34007 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-11 06:05:24 +00:00
Scott Taylor 67f90df6a4 `Walker_Comment` should be in its own file. Loaded now via `wp-includes/comment.php`, which makes it 100% BC.
See #33413.

Built from https://develop.svn.wordpress.org/trunk@33962


git-svn-id: http://core.svn.wordpress.org/trunk@33931 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-09 02:41:24 +00:00