WordPress.org

Make WordPress Core

Opened 9 years ago

Closed 9 years ago

#7527 closed enhancement (fixed)

Inline Documentation for wp-admin/includes Files

Reported by: santosj Owned by:
Milestone: 2.7.1 Priority: low
Severity: trivial Version:
Component: Optimization Keywords: phpdoc
Focuses: Cc:

Description

Patches for wp-admin/includes directory files for adding inline documentation.

Attachments (8)

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

Download all attachments as: .zip

Change History (21)

@santosj
9 years ago

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

#1 @santosj
9 years ago

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.

#2 @santosj
9 years ago

  • Keywords phpdoc added

@santosj
9 years ago

Plugin.php inline documentation based off of r8762

#3 @jacobsantos
9 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.

#4 @jacobsantos
9 years ago

  • Keywords has-patch added

#5 @jacobsantos
9 years ago

  • Summary changed from Wp-admin/includes Inline Documentation to Inline Documentation for wp-admin/includes Files

@jacobsantos
9 years ago

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

#6 @jacobsantos
9 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.

#7 @ryan
9 years ago

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

@jacobsantos
9 years ago

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

#8 @jacobsantos
9 years ago

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

@jacobsantos
9 years ago

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

@jacobsantos
9 years ago

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

#9 @ryan
9 years ago

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

#10 @ShaneF
9 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.

#11 @jacobsantos
9 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
9 years ago

wp-admin and wp-admin/includes inline documentation

@jacobsantos
9 years ago

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

#12 @ryan
9 years ago

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

#13 @jacobsantos
9 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.

Note: See TracTickets for help on using tickets.