Inline Documentation for wp-admin/includes Files

[santosj]

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

[santosj]

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

[santosj]

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.

[santosj]

Plugin.php inline documentation based off of r8762

[jacobsantos]

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.

[jacobsantos]

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

[jacobsantos]

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.

[ryan]

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

[jacobsantos]

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

[jacobsantos]

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

[jacobsantos]

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

[ryan]

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

[ShaneF]

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.

[jacobsantos]

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]

wp-admin and wp-admin/includes inline documentation

[jacobsantos]

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

[ryan]

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

[jacobsantos]

Can this be moved to 2.7?

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