From c1d8f9cd6919ea5ca391c65ae65f2d655e3ff585 Mon Sep 17 00:00:00 2001
From: Andrew Nacin <nacin@git.wordpress.org>
Date: Mon, 25 Oct 2010 04:04:18 +0000
Subject: [PATCH] phpdoc for the various list table includes. see #14579.

git-svn-id: https://develop.svn.wordpress.org/trunk@15958 602fd350-edb4-49c9-b593-d223f7449a82
---
 wp-admin/includes/class-wp-list-table.php     | 14 ++++++++---
 wp-admin/includes/list-table-comments.php     | 24 +++++++++++++++----
 wp-admin/includes/list-table-links.php        |  9 +++----
 wp-admin/includes/list-table-media.php        |  9 +++----
 wp-admin/includes/list-table-ms-users.php     |  9 +++----
 .../includes/list-table-plugin-install.php    |  9 +++----
 wp-admin/includes/list-table-plugins.php      |  9 +++----
 wp-admin/includes/list-table-posts.php        |  8 +++----
 wp-admin/includes/list-table-sites.php        |  9 +++----
 wp-admin/includes/list-table-terms.php        |  9 +++----
 .../includes/list-table-theme-install.php     |  9 +++----
 wp-admin/includes/list-table-themes.php       |  9 +++----
 wp-admin/includes/list-table-users.php        |  9 +++----
 13 files changed, 63 insertions(+), 73 deletions(-)

diff --git a/wp-admin/includes/class-wp-list-table.php b/wp-admin/includes/class-wp-list-table.php
index 6abededd34..90ca60cdcb 100644
--- a/wp-admin/includes/class-wp-list-table.php
+++ b/wp-admin/includes/class-wp-list-table.php
@@ -1,9 +1,17 @@
 <?php
-
 /**
- * Base class for displaying a list of items as an ajaxified html table
+ * Base class and helper functions for displaying a list of items in an ajaxified HTML table.
  *
  * @package WordPress
+ * @subpackage List_Table
+ * @since 3.1.0
+ */
+
+/**
+ * Base class for displaying a list of items in an ajaxified HTML table.
+ *
+ * @package WordPress
+ * @subpackage List_Table
  * @since 3.1.0
  */
 class WP_List_Table {
@@ -811,7 +819,7 @@ class WP_List_Table {
 }
 
 /**
- * Fetch an instance of a WP_List_Table class
+ * Fetch an instance of a WP_List_Table class.
  *
  * @since 3.1.0
  *
diff --git a/wp-admin/includes/list-table-comments.php b/wp-admin/includes/list-table-comments.php
index e8a3243856..6e3bc472b3 100644
--- a/wp-admin/includes/list-table-comments.php
+++ b/wp-admin/includes/list-table-comments.php
@@ -1,14 +1,21 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Comments and Post Comments List Table classes.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
 
+/**
+ * Post Comments List Table class.
+ *
+ * @package WordPress
+ * @subpackage List_Table
+ * @since 3.1.0
+ *
+ * @see WP_Comments_Table
+ */
 class WP_Post_Comments_Table extends WP_Comments_Table {
 
 	function get_columns() {
@@ -23,6 +30,13 @@ class WP_Post_Comments_Table extends WP_Comments_Table {
 	}
 }
 
+/**
+ * Comments List Table class.
+ *
+ * @package WordPress
+ * @subpackage List_Table
+ * @since 3.1.0
+ */
 class WP_Comments_Table extends WP_List_Table {
 
 	var $checkbox = true;
diff --git a/wp-admin/includes/list-table-links.php b/wp-admin/includes/list-table-links.php
index ac7c1ec2d8..98c01a9ad3 100644
--- a/wp-admin/includes/list-table-links.php
+++ b/wp-admin/includes/list-table-links.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Links Manager List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Links_Table extends WP_List_Table {
 
 	function WP_Links_Table() {
diff --git a/wp-admin/includes/list-table-media.php b/wp-admin/includes/list-table-media.php
index 534361b1a6..dd1cf6adc5 100644
--- a/wp-admin/includes/list-table-media.php
+++ b/wp-admin/includes/list-table-media.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Media Library List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Media_Table extends WP_List_Table {
 
 	function WP_Media_Table() {
diff --git a/wp-admin/includes/list-table-ms-users.php b/wp-admin/includes/list-table-ms-users.php
index 99403fec9b..9b3e9828d6 100644
--- a/wp-admin/includes/list-table-ms-users.php
+++ b/wp-admin/includes/list-table-ms-users.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Multisite Users List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_MS_Users_Table extends WP_List_Table {
 
 	function WP_MS_Users_Table() {
diff --git a/wp-admin/includes/list-table-plugin-install.php b/wp-admin/includes/list-table-plugin-install.php
index c278b0a653..bf55cccdc9 100644
--- a/wp-admin/includes/list-table-plugin-install.php
+++ b/wp-admin/includes/list-table-plugin-install.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Plugin Installer List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Plugin_Install_Table extends WP_List_Table {
 
 	function WP_Plugin_Install_Table() {
diff --git a/wp-admin/includes/list-table-plugins.php b/wp-admin/includes/list-table-plugins.php
index 4e70928de8..43776c283a 100644
--- a/wp-admin/includes/list-table-plugins.php
+++ b/wp-admin/includes/list-table-plugins.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Plugins List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Plugins_Table extends WP_List_Table {
 
 	function WP_Plugins_Table() {
diff --git a/wp-admin/includes/list-table-posts.php b/wp-admin/includes/list-table-posts.php
index a8763cbe52..a1b90fffa4 100644
--- a/wp-admin/includes/list-table-posts.php
+++ b/wp-admin/includes/list-table-posts.php
@@ -1,13 +1,11 @@
 <?php
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Posts List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Posts_Table extends WP_List_Table {
 
 	/**
diff --git a/wp-admin/includes/list-table-sites.php b/wp-admin/includes/list-table-sites.php
index 5730aa744d..f0dd27258e 100644
--- a/wp-admin/includes/list-table-sites.php
+++ b/wp-admin/includes/list-table-sites.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Sites List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Sites_Table extends WP_List_Table {
 
 	function WP_Sites_Table() {
diff --git a/wp-admin/includes/list-table-terms.php b/wp-admin/includes/list-table-terms.php
index 8081d2ff5c..18a5d7acf0 100644
--- a/wp-admin/includes/list-table-terms.php
+++ b/wp-admin/includes/list-table-terms.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Terms List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Terms_Table extends WP_List_Table {
 
 	var $callback_args;
diff --git a/wp-admin/includes/list-table-theme-install.php b/wp-admin/includes/list-table-theme-install.php
index 2375300a40..fd5233b663 100644
--- a/wp-admin/includes/list-table-theme-install.php
+++ b/wp-admin/includes/list-table-theme-install.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Theme Installer List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Theme_Install_Table extends WP_List_Table {
 
 	function WP_Theme_Install_Table() {
diff --git a/wp-admin/includes/list-table-themes.php b/wp-admin/includes/list-table-themes.php
index 47232d7612..2544824b16 100644
--- a/wp-admin/includes/list-table-themes.php
+++ b/wp-admin/includes/list-table-themes.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Themes List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Themes_Table extends WP_List_Table {
 
 	var $search = array();
diff --git a/wp-admin/includes/list-table-users.php b/wp-admin/includes/list-table-users.php
index c0ae5abfd5..a3858c4522 100644
--- a/wp-admin/includes/list-table-users.php
+++ b/wp-admin/includes/list-table-users.php
@@ -1,14 +1,11 @@
 <?php
-
 /**
- * List table classes
- *
- * Each list-type admin screen has a class that handles the rendering of the list table.
+ * Users List Table class.
  *
  * @package WordPress
- * @subpackage Administration
+ * @subpackage List_Table
+ * @since 3.1.0
  */
-
 class WP_Users_Table extends WP_List_Table {
 
 	function WP_Users_Table() {