Make WordPress Core

Opened 16 years ago

Closed 16 years ago

#7496 closed enhancement (fixed)

WP-Admin File Level Inline Documentation for 2.7

Reported by: santosj's profile santosj Owned by: westi's profile westi
Milestone: 2.7 Priority: lowest
Severity: trivial Version: 2.7
Component: Optimization Keywords: phpdoc has-patch
Focuses: Cc:

Description

Patches for adding file level inline documentation to wp-admin files.

Attachments (7)

7496.phpdoc.r8616.patch (10.8 KB) - added by santosj 16 years ago.
File level inline documentation for some of wp-admin files based off of r8616.
7496.phpdoc.r8623.patch (22.7 KB) - added by santosj 16 years ago.
More file level and other phpdoc for wp-admin directory based off of r8623
7496.phpdoc.r8636.patch (22.7 KB) - added by santosj 16 years ago.
More file and function level inline documentation for wp-admin files, based off of r8636
7496.phpdoc.r8640.patch (49.4 KB) - added by santosj 16 years ago.
More file level and other phpdoc for wp-admin directory based off of r8640
7496.phpdoc.r8653.patch (22.8 KB) - added by santosj 16 years ago.
Finishes the file level inline documentation for wp-admin/*.php. Need to finish wp-admin/includes/*.php files. Based off of r8653
7496.r8656.diff (469 bytes) - added by jacobsantos 16 years ago.
wp-admin/sidebar.php file level inline documentation completes ticket based off of r8656
7496.r8656.2.diff (913 bytes) - added by jacobsantos 16 years ago.
From base WordPress, completes wp-admin file level inline documentation based off of r8656

Download all attachments as: .zip

Change History (20)

@santosj
16 years ago

File level inline documentation for some of wp-admin files based off of r8616.

#1 @santosj
16 years ago

There are a lot of files in wp-admin/ directory. I'm going to complete them in sets of files, once I understand what most of them are. Might be able to use the codex for most of the files.

#2 @santosj
16 years ago

  • Keywords phpdoc has-patch added

#3 @ryan
16 years ago

(In [8618]) WP-Admin File Level Inline Documentation from santosj. see #7496

#4 @santosj
16 years ago

  • Summary changed from WP-Admin File Level Inline Documentation to WP-Admin File Level Inline Documentation for 2.7

@santosj
16 years ago

More file level and other phpdoc for wp-admin directory based off of r8623

@santosj
16 years ago

More file and function level inline documentation for wp-admin files, based off of r8636

@santosj
16 years ago

More file level and other phpdoc for wp-admin directory based off of r8640

#5 @santosj
16 years ago

Latest patch 7496.phpdoc.r8640.patch includes file level inline documentation for the WordPress Importers. The patch is starting to get large. Is there a problem that I need to resolve with the patch in order to get it in?

#6 @santosj
16 years ago

  • Owner changed from anonymous to jacobsantos

#7 @westi
16 years ago

  • Owner changed from jacobsantos to westi
  • Status changed from new to assigned

That is large.

I will have a look at get it in.

#8 @westi
16 years ago

(In [8645]) phpdoc for wp-admin. See #7496 props santosj.

#9 @jacobsantos
16 years ago

Would you rather me have smaller patches?

I realize that you have to review the patches for consistency, accuracy, and to make sure things don't go "boom!" There is a but, but I'm not sure what I'm trying to say.

@santosj
16 years ago

Finishes the file level inline documentation for wp-admin/*.php. Need to finish wp-admin/includes/*.php files. Based off of r8653

#11 @santosj
16 years ago

What is wp-admin/sidebar.php used for? It appears to be a write post page, and that is all. Was it the previous bookmarklet before Press This? It is the only file that needs file level documentation, but I'm not going to do anything with it, until I know for sure what it is.

The focus is now going to turn to wp-admin/includes/*.php, which will be in separate tickets.

#12 @westi
16 years ago

(In [8656]) More phpdoc updates for wp-adming. See #7496 props santosj.

@jacobsantos
16 years ago

wp-admin/sidebar.php file level inline documentation completes ticket based off of r8656

@jacobsantos
16 years ago

From base WordPress, completes wp-admin file level inline documentation based off of r8656

#13 @ryan
16 years ago

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [8674]) File level phpdoc from santosj. fixes #7496

Note: See TracTickets for help on using tickets.