From 5bf79d1d8e3d71d58c2e5385225e64a40d588f51 Mon Sep 17 00:00:00 2001
From: Andrew Nacin <nacin@git.wordpress.org>
Date: Sun, 4 Apr 2010 13:29:35 +0000
Subject: [PATCH] File-level phpdoc for multisite files.

git-svn-id: https://develop.svn.wordpress.org/trunk@13998 602fd350-edb4-49c9-b593-d223f7449a82
---
 wp-admin/includes/ms-deprecated.php  | 36 +++++++++++++++++-----------
 wp-admin/includes/ms.php             |  7 ++++++
 wp-admin/ms-admin.php                |  8 +++++++
 wp-admin/ms-delete-site.php          |  8 +++++++
 wp-admin/ms-edit.php                 | 11 +++++++++
 wp-admin/ms-options.php              |  8 +++++++
 wp-admin/ms-sites.php                |  8 +++++++
 wp-admin/ms-themes.php               |  8 +++++++
 wp-admin/ms-upgrade-network.php      |  8 +++++++
 wp-admin/ms-users.php                |  8 +++++++
 wp-admin/my-sites.php                |  8 +++++++
 wp-includes/ms-default-constants.php |  1 +
 wp-includes/ms-default-filters.php   |  1 +
 wp-includes/ms-deprecated.php        |  1 +
 wp-includes/ms-functions.php         |  2 ++
 wp-includes/ms-settings.php          |  1 +
 16 files changed, 110 insertions(+), 14 deletions(-)

diff --git a/wp-admin/includes/ms-deprecated.php b/wp-admin/includes/ms-deprecated.php
index e2c62c706f..e7b017bebe 100644
--- a/wp-admin/includes/ms-deprecated.php
+++ b/wp-admin/includes/ms-deprecated.php
@@ -1,59 +1,67 @@
 <?php
-
 /**
- * Deprecated multisite admin functions from past WordPress versions. You shouldn't use these
- * globals and functions and look for the alternatives instead. The functions
- * and globals will be removed in a later version.
+ * Deprecated multisite admin functions from past WordPress versions and WordPress MU.
+ * You shouldn't use these functions and look for the alternatives instead. The functions
+ * will be removed in a later version.
  *
  * @package WordPress
  * @subpackage Deprecated
+ * @since 3.0.0
  */
 
 /**
- * @deprecated 3.0
+ * @deprecated 3.0.0
  */
 function wpmu_menu() {
-	_deprecated_function(__FUNCTION__, '3.0', '' );
+	_deprecated_function(__FUNCTION__, '3.0' );
 	// deprecated. See #11763
 }
 
 /**
-  * Determines if the available space defined by the admin has been exceeded by the user. Dies if it has.
-  * @deprecated 3.0
+  * Determines if the available space defined by the admin has been exceeded by the user.
+  *
+  * @deprecated 3.0.0
+  * @see is_upload_space_available()
  */
 function wpmu_checkAvailableSpace() {
-	_deprecated_function(__FUNCTION__, '3.0', 'is_upload_space_available' );
+	_deprecated_function(__FUNCTION__, '3.0', 'is_upload_space_available()' );
 
 	if ( !is_upload_space_available() )
 		wp_die( __('Sorry, you must delete files before you can upload any more.') );
 }
 
 /**
- * @deprecated 3.0
+ * @deprecated 3.0.0
  */
 function mu_options( $options ) {
-	_deprecated_function(__FUNCTION__, '3.0', '' );
+	_deprecated_function(__FUNCTION__, '3.0' );
 	return $options;
 }
 
 /**
- * @deprecated 3.0
+ * @deprecated 3.0.0
+ * @see activate_plugin()
  */
 function activate_sitewide_plugin() {
+	_deprecated_function(__FUNCTION__, '3.0', 'activate_plugin()' );
 	return false;
 }
 
 /**
- * @deprecated 3.0
+ * @deprecated 3.0.0
+ * @see deactivate_sitewide_plugin()
  */
 function deactivate_sitewide_plugin( $plugin = false ) {
+	_deprecated_function(__FUNCTION__, '3.0', 'deactivate_plugin()' );
 	return;
 }
 
 /**
- * @deprecated 3.0 is_network_only_plugin()
+ * @deprecated 3.0.0
+ * @see is_network_only_plugin()
  */
 function is_wpmu_sitewide_plugin( $file ) {
+	_deprecated_function(__FUNCTION__, '3.0', 'is_network_only_plugin()' );
 	return is_network_only_plugin( $file );
 }
 
diff --git a/wp-admin/includes/ms.php b/wp-admin/includes/ms.php
index 76180b5407..eb8c91ca89 100644
--- a/wp-admin/includes/ms.php
+++ b/wp-admin/includes/ms.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * Multisite administration functions.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
 
 /**
  * Determine if uploaded file exceeds space quota.
diff --git a/wp-admin/ms-admin.php b/wp-admin/ms-admin.php
index 0a7015ee00..91a7514c3d 100644
--- a/wp-admin/ms-admin.php
+++ b/wp-admin/ms-admin.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Multisite administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once( './admin.php' );
 
 if ( !is_multisite() )
diff --git a/wp-admin/ms-delete-site.php b/wp-admin/ms-delete-site.php
index 0ed25a3e12..b49a02204b 100644
--- a/wp-admin/ms-delete-site.php
+++ b/wp-admin/ms-delete-site.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Multisite delete site panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once( './admin.php' );
 
 if ( !is_multisite() )
diff --git a/wp-admin/ms-edit.php b/wp-admin/ms-edit.php
index 3780a8db61..80ee159252 100644
--- a/wp-admin/ms-edit.php
+++ b/wp-admin/ms-edit.php
@@ -1,9 +1,20 @@
 <?php
+/**
+ * Action handler for Multisite administration panels.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once( './admin.php' );
 
 if ( !is_multisite() )
 	wp_die( __( 'Multisite support is not enabled.' ) );
 
+if ( empty( $_GET['action'] ) )
+	wp_redirect( admin_url( 'ms-admin.php' ) );
+
 do_action( 'wpmuadminedit' , '');
 
 if ( isset( $_GET['id' ]) )
diff --git a/wp-admin/ms-options.php b/wp-admin/ms-options.php
index a86b137da3..a07b657838 100644
--- a/wp-admin/ms-options.php
+++ b/wp-admin/ms-options.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Multisite network settings administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once( './admin.php' );
 
 if ( ! is_multisite() )
diff --git a/wp-admin/ms-sites.php b/wp-admin/ms-sites.php
index fc4f5744cc..cf5ff7f54c 100644
--- a/wp-admin/ms-sites.php
+++ b/wp-admin/ms-sites.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Multisite sites administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once( './admin.php' );
 
 if ( !is_multisite() )
diff --git a/wp-admin/ms-themes.php b/wp-admin/ms-themes.php
index 126951c47c..62a9918429 100644
--- a/wp-admin/ms-themes.php
+++ b/wp-admin/ms-themes.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Multisite themes administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once( './admin.php' );
 
 if ( ! current_user_can( 'manage_network_themes' ) )
diff --git a/wp-admin/ms-upgrade-network.php b/wp-admin/ms-upgrade-network.php
index 0598233428..19c3611832 100644
--- a/wp-admin/ms-upgrade-network.php
+++ b/wp-admin/ms-upgrade-network.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Multisite upgrade administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once('admin.php');
 
 if ( !is_multisite() )
diff --git a/wp-admin/ms-users.php b/wp-admin/ms-users.php
index ffc1cd69aa..9ad0df1af6 100644
--- a/wp-admin/ms-users.php
+++ b/wp-admin/ms-users.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Multisite users administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once( './admin.php' );
 
 if ( !is_multisite() )
diff --git a/wp-admin/my-sites.php b/wp-admin/my-sites.php
index 55a1e64b40..d65964fc6f 100644
--- a/wp-admin/my-sites.php
+++ b/wp-admin/my-sites.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * My Sites dashboard.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
 require_once( './admin.php' );
 
 if ( !is_multisite() )
diff --git a/wp-includes/ms-default-constants.php b/wp-includes/ms-default-constants.php
index 7cf68dd061..ac3e612f07 100644
--- a/wp-includes/ms-default-constants.php
+++ b/wp-includes/ms-default-constants.php
@@ -4,6 +4,7 @@
  *
  * @package WordPress
  * @subpackage Multisite
+ * @since 3.0.0
  */
 
 /**
diff --git a/wp-includes/ms-default-filters.php b/wp-includes/ms-default-filters.php
index c401be49ed..2f58540878 100644
--- a/wp-includes/ms-default-filters.php
+++ b/wp-includes/ms-default-filters.php
@@ -10,6 +10,7 @@
  * @package WordPress
  * @subpackage Multisite
  * @see default-filters.php
+ * @since 3.0.0
  */
 
 // Users
diff --git a/wp-includes/ms-deprecated.php b/wp-includes/ms-deprecated.php
index 9f667bbf1b..12d8056a65 100644
--- a/wp-includes/ms-deprecated.php
+++ b/wp-includes/ms-deprecated.php
@@ -6,6 +6,7 @@
  *
  * @package WordPress
  * @subpackage Deprecated
+ * @since 3.0.0
  */
 
 /*
diff --git a/wp-includes/ms-functions.php b/wp-includes/ms-functions.php
index 6b5e0d4e70..e277d710c4 100644
--- a/wp-includes/ms-functions.php
+++ b/wp-includes/ms-functions.php
@@ -3,6 +3,8 @@
  * Multi-site WordPress API
  *
  * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
  */
 
 function get_sitestats() {
diff --git a/wp-includes/ms-settings.php b/wp-includes/ms-settings.php
index 52b5c765f5..9c89404ec2 100644
--- a/wp-includes/ms-settings.php
+++ b/wp-includes/ms-settings.php
@@ -7,6 +7,7 @@
  *
  * @package WordPress
  * @subpackage Multisite
+ * @since 3.0.0
  */
 
 // $base sanity check.