Ticket #5635 (closed enhancement: fixed)
PHPdoc effort for classes.php
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Priority: | low | Milestone: | 2.7 |
| Component: | Optimization | Version: | |
| Severity: | trivial | Keywords: | phpdoc has-patch |
| Cc: |
Description
PHPdoc effort seeks to complete phpdoc style inline documentation for wp-includes/classes.php.
Needed to complete:
- Short and Long Descriptions.
- @since version info
- parameter type and description.
- return type and description.
Attachments
-
classes.phpdoc.r6597.diff
(18.8 KB) -
added by darkdragon 4 years ago.
- Incomplete documentation for classes.php based off of r6597
-
5635.r8889.diff
(24.8 KB) -
added by jacobsantos 3 years ago.
- Complete inline documentation for classes.php based off of r8889
Change History
darkdragon — 4 years ago
-
attachment
classes.phpdoc.r6597.diff
added
comment:1
darkdragon — 4 years ago
- Milestone changed from 2.6 to 2.7
Eh. Probably complete this during the summer. Patch is available for anyone who wants to take ownership of this file. Template covers everything that needs to be completed.
comment:2
darkdragon — 4 years ago
Remember, the revision has to match before you can apply the patch, unless there weren't too many changes. Checkout r6597, apply patch, and then update repository.
- Milestone changed from 2.7 to 2.9
Yeah. There are a lot of places where inline documentation is needed and it isn't as quick as some other files. I won't be doing this until the end, because the file has difficult to understand sections of code which need more thought.
jacobsantos — 3 years ago
-
attachment
5635.r8889.diff
added
Complete inline documentation for classes.php based off of r8889
Incomplete documentation for classes.php based off of r6597