Ticket #7527 (closed enhancement: fixed)

Opened 3 years ago

Last modified 3 years ago

Inline Documentation for wp-admin/includes Files

Reported by: santosj Owned by: anonymous
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

7527.r8653.patch Download (30.7 KB) - added by santosj 3 years ago.
Incomplete patch with all template inline documentation to work on this weekend.
7527.plugin.r8762.diff Download (6.6 KB) - added by santosj 3 years ago.
Plugin.php inline documentation based off of r8762
7527.r8903.patch Download (35.2 KB) - added by jacobsantos 3 years ago.
Inline documentation for wp-admin/includes files based off of r8903
7527.r8921.diff Download (25.5 KB) - added by jacobsantos 3 years ago.
Skeleton and corrections to wp-admin/includes files, based off of r8921
wp-admin-includes.phpdoc.r8976.diff Download (28.3 KB) - added by jacobsantos 3 years ago.
More inline documentation for wp-admin files based off of r8976
7527.r9046.diff Download (94.6 KB) - added by jacobsantos 3 years ago.
Skeleton and complete inline documentation for wp-admin/includes based off of r9046
7527.phpdoc.diff Download (29.9 KB) - added by jacobsantos 3 years ago.
wp-admin and wp-admin/includes inline documentation
7527.r9118.diff Download (29.9 KB) - added by jacobsantos 3 years ago.
inline documentation for wp-admin and wp-admin/includes based off of r9118

Change History

santosj3 years ago

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

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.

  • Keywords phpdoc added

santosj3 years ago

Plugin.php inline documentation based off of r8762

  • 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.

  • Keywords has-patch added
  • Summary changed from Wp-admin/includes Inline Documentation to Inline Documentation for wp-admin/includes Files

Inline documentation for wp-admin/includes files based off of r8903

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:7   ryan3 years ago

(In [8912]) phpdoc for wp-admin/includes from jacobsantos. see #7527

Skeleton and corrections to wp-admin/includes files, based off of r8921

  • Keywords needs-patch added; has-patch removed
  • Milestone changed from 2.7 to 2.8

More inline documentation for wp-admin files based off of r8976

Skeleton and complete inline documentation for wp-admin/includes based off of r9046

comment:9   ryan3 years ago

(In [9053]) phpdoc for wp-admin/includes from jacobsantos. see #7527

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.

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.

wp-admin and wp-admin/includes inline documentation

inline documentation for wp-admin and wp-admin/includes based off of r9118

(In [9119]) phpdoc for wp-admin. Props jacobsantos. see #7527

  • Keywords needs-patch removed
  • Status changed from new to closed
  • Resolution set to fixed
  • Milestone changed from 2.8 to 2.7.1

Can this be moved to 2.7?

I plan on creating tickets for each of the files in February.

Note: See TracTickets for help on using tickets.