From 5a0fd03f95345837908a249725f928510c1d0b93 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Sat, 17 Oct 2015 15:12:48 +0000
Subject: [PATCH] Docs: Add missing file headers to the list table classes and
 adjust class DocBlocks accordingly.

See #33701.


git-svn-id: https://develop.svn.wordpress.org/trunk@35241 602fd350-edb4-49c9-b593-d223f7449a82
---
 .../includes/class-wp-comments-list-table.php       | 10 +++++-----
 src/wp-admin/includes/class-wp-links-list-table.php | 12 ++++++++++--
 src/wp-admin/includes/class-wp-media-list-table.php | 12 ++++++++++--
 .../includes/class-wp-ms-sites-list-table.php       | 12 ++++++++++--
 .../includes/class-wp-ms-themes-list-table.php      | 12 ++++++++++--
 .../includes/class-wp-ms-users-list-table.php       | 12 ++++++++++--
 .../includes/class-wp-plugin-install-list-table.php | 12 ++++++++++--
 .../includes/class-wp-plugins-list-table.php        | 12 ++++++++++--
 .../includes/class-wp-post-comments-list-table.php  |  6 +++---
 src/wp-admin/includes/class-wp-posts-list-table.php | 12 ++++++++++--
 src/wp-admin/includes/class-wp-terms-list-table.php | 12 ++++++++++--
 .../includes/class-wp-theme-install-list-table.php  | 12 ++++++++++--
 .../includes/class-wp-themes-list-table.php         | 12 ++++++++++--
 src/wp-admin/includes/class-wp-users-list-table.php | 13 ++++++++++---
 14 files changed, 128 insertions(+), 33 deletions(-)

diff --git a/src/wp-admin/includes/class-wp-comments-list-table.php b/src/wp-admin/includes/class-wp-comments-list-table.php
index c3d81a5702..7a06cd13e3 100644
--- a/src/wp-admin/includes/class-wp-comments-list-table.php
+++ b/src/wp-admin/includes/class-wp-comments-list-table.php
@@ -1,19 +1,19 @@
 <?php
 /**
- * Comments List Table class.
+ * List Table API: WP_Comments_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
  * @since 3.1.0
  */
 
 /**
- * Comments List Table class.
+ * Core class used to implement displaying comments in a list table.
  *
- * @package WordPress
- * @subpackage List_Table
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_Comments_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-links-list-table.php b/src/wp-admin/includes/class-wp-links-list-table.php
index 9b917d1db4..4af3a5b5f2 100644
--- a/src/wp-admin/includes/class-wp-links-list-table.php
+++ b/src/wp-admin/includes/class-wp-links-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Links Manager List Table class.
+ * List Table API: WP_Links_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying links in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Tsble
  */
 class WP_Links_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-media-list-table.php b/src/wp-admin/includes/class-wp-media-list-table.php
index 0897d3fcb3..08d9922fc0 100644
--- a/src/wp-admin/includes/class-wp-media-list-table.php
+++ b/src/wp-admin/includes/class-wp-media-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Media Library List Table class.
+ * List Table API: WP_Media_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying media items in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_Media_List_Table extends WP_List_Table {
 	/**
diff --git a/src/wp-admin/includes/class-wp-ms-sites-list-table.php b/src/wp-admin/includes/class-wp-ms-sites-list-table.php
index 176effc5b7..cf3acf9225 100644
--- a/src/wp-admin/includes/class-wp-ms-sites-list-table.php
+++ b/src/wp-admin/includes/class-wp-ms-sites-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Sites List Table class.
+ * List Table API: WP_MS_Sites_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying sites in a list table for the network admin.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_MS_Sites_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-ms-themes-list-table.php b/src/wp-admin/includes/class-wp-ms-themes-list-table.php
index 3298f96de3..ef1ab91b3d 100644
--- a/src/wp-admin/includes/class-wp-ms-themes-list-table.php
+++ b/src/wp-admin/includes/class-wp-ms-themes-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * MS Themes List Table class.
+ * List Table API: WP_MS_Themes_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying themes in a list table for the network admin.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_MS_Themes_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-ms-users-list-table.php b/src/wp-admin/includes/class-wp-ms-users-list-table.php
index 66a7fe08c6..9062d9f084 100644
--- a/src/wp-admin/includes/class-wp-ms-users-list-table.php
+++ b/src/wp-admin/includes/class-wp-ms-users-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Multisite Users List Table class.
+ * List Table API: WP_MS_Users_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying users in a list table for the network admin.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_MS_Users_List_Table extends WP_List_Table {
 	/**
diff --git a/src/wp-admin/includes/class-wp-plugin-install-list-table.php b/src/wp-admin/includes/class-wp-plugin-install-list-table.php
index 879a4d4b6d..ba8445c1bd 100644
--- a/src/wp-admin/includes/class-wp-plugin-install-list-table.php
+++ b/src/wp-admin/includes/class-wp-plugin-install-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Plugin Installer List Table class.
+ * List Table API: WP_Plugin_Install_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying plugins to install in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_Plugin_Install_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-plugins-list-table.php b/src/wp-admin/includes/class-wp-plugins-list-table.php
index d58215f5f7..3a51d177f7 100644
--- a/src/wp-admin/includes/class-wp-plugins-list-table.php
+++ b/src/wp-admin/includes/class-wp-plugins-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Plugins List Table class.
+ * List Table API: WP_Plugins_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying installed plugins in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_Plugins_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-post-comments-list-table.php b/src/wp-admin/includes/class-wp-post-comments-list-table.php
index e591e536f9..719d65537e 100644
--- a/src/wp-admin/includes/class-wp-post-comments-list-table.php
+++ b/src/wp-admin/includes/class-wp-post-comments-list-table.php
@@ -1,14 +1,14 @@
 <?php
 /**
- * Comment API: WP_Post_Comments_List_Table class
+ * List Table API: WP_Post_Comments_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
  * @since 4.4.0
  */
 
 /**
- * Core list table class used to output the post comments list table.
+ * Core class used to implement displaying post comments in a list table.
  *
  * @since 3.1.0
  * @access private
diff --git a/src/wp-admin/includes/class-wp-posts-list-table.php b/src/wp-admin/includes/class-wp-posts-list-table.php
index a538c41b8b..870b48d533 100644
--- a/src/wp-admin/includes/class-wp-posts-list-table.php
+++ b/src/wp-admin/includes/class-wp-posts-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Posts List Table class.
+ * List Table API: WP_Posts_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying posts in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_Posts_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-terms-list-table.php b/src/wp-admin/includes/class-wp-terms-list-table.php
index f8568e270b..8cfeedf673 100644
--- a/src/wp-admin/includes/class-wp-terms-list-table.php
+++ b/src/wp-admin/includes/class-wp-terms-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Terms List Table class.
+ * List Table API: WP_Terms_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying terms in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_Terms_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-theme-install-list-table.php b/src/wp-admin/includes/class-wp-theme-install-list-table.php
index 63b11051f5..a6a2c2c779 100644
--- a/src/wp-admin/includes/class-wp-theme-install-list-table.php
+++ b/src/wp-admin/includes/class-wp-theme-install-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Theme Installer List Table class.
+ * List Table API: WP_Theme_Install_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying themes to install in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_Thenes_List_Table
  */
 class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-themes-list-table.php b/src/wp-admin/includes/class-wp-themes-list-table.php
index e01e3d4636..2426e61223 100644
--- a/src/wp-admin/includes/class-wp-themes-list-table.php
+++ b/src/wp-admin/includes/class-wp-themes-list-table.php
@@ -1,11 +1,19 @@
 <?php
 /**
- * Themes List Table class.
+ * List Table API: WP_Themes_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying installed themes in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Table
  */
 class WP_Themes_List_Table extends WP_List_Table {
 
diff --git a/src/wp-admin/includes/class-wp-users-list-table.php b/src/wp-admin/includes/class-wp-users-list-table.php
index 0f892d1176..9e26867df9 100644
--- a/src/wp-admin/includes/class-wp-users-list-table.php
+++ b/src/wp-admin/includes/class-wp-users-list-table.php
@@ -1,12 +1,19 @@
 <?php
 /**
- * Users List Table class.
+ * List Table API: WP_Users_List_Table class
+ *
+ * @package WordPress
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying users in a list table.
  *
  * @since 3.1.0
  * @access private
  *
- * @package WordPress
- * @subpackage List_Table
+ * @see WP_List_Table
  */
 class WP_Users_List_Table extends WP_List_Table {