Opened 5 years ago
Closed 4 years ago
#7527 closed enhancement (fixed)
Inline Documentation for wp-admin/includes Files
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Priority: | low | Milestone: | 2.7.1 |
| Component: | Optimization | Version: | |
| Severity: | trivial | Keywords: | phpdoc |
| Cc: |
Description
Patches for wp-admin/includes directory files for adding inline documentation.
Attachments (8)
Change History (21)
Plan is to complete as many of the smaller file as possible. Some of the bigger files seem boring, so will try to work on those after wp-includes directory smaller files are completed. Most likely they will be completed in smaller patches, or a few functions documented at a time until the file is complete.
Over half the file should be completed. I think only about 2 or 3 will be put on hold. The issue with time is that a lot of the functions are a lot more difficult to understand the purpose and they aren't functions that other developers will use except in WordPress Administration files.
Thinking several of them could just use file level inline documentation and think about finishing them in 2.8 version.
comment:3
jacobsantos — 5 years ago
- Summary changed from Wp-admin/includes Inline Documentation for 2.7 to Wp-admin/includes Inline Documentation
Well, you can close this if this isn't complete by the time 2.7 is released. Will create a new one for 2.8.
comment:4
jacobsantos — 5 years ago
- Keywords has-patch added
comment:5
jacobsantos — 5 years ago
- Summary changed from Wp-admin/includes Inline Documentation to Inline Documentation for wp-admin/includes Files
comment:6
jacobsantos — 5 years ago
Please commit 7527.r8903.patch, the patch completes the majority of wp-admin/includes/image.php, cleans up coding standard violations, and adds skeleton inline documentation to other functions that aren't completely documented.
comment:8
jacobsantos — 5 years ago
- Keywords needs-patch added; has-patch removed
- Milestone changed from 2.7 to 2.8
jacobsantos — 5 years ago
Skeleton and complete inline documentation for wp-admin/includes based off of r9046
comment:10
ShaneF — 5 years ago
media.php will have to be re-done at one point since I am working on the attachment system. I just got a conflict state on my development version because of the number of changes to it.
comment:11
jacobsantos — 5 years ago
Yeah, I usually get a lot of those while working on inline documentation. Actually, if you could, you know, perhaps document the file, that would be great too.
jacobsantos — 5 years ago
inline documentation for wp-admin and wp-admin/includes based off of r9118
comment:12
ryan — 5 years ago
comment:13
jacobsantos — 4 years ago
- Keywords needs-patch removed
- Milestone changed from 2.8 to 2.7.1
- Resolution set to fixed
- Status changed from new to closed
Can this be moved to 2.7?
I plan on creating tickets for each of the files in February.

Incomplete patch with all template inline documentation to work on this weekend.