From fea88ce18407b34fa0cb9c69e0a9519d6812b2ee Mon Sep 17 00:00:00 2001
From: Ryan Boren <ryan@git.wordpress.org>
Date: Tue, 14 May 2013 12:37:30 +0000
Subject: [PATCH] phpdoc improvements for wp_dashboard_quota()

Props DrewAPicture, h4ck3rm1k3


git-svn-id: https://develop.svn.wordpress.org/trunk@24246 602fd350-edb4-49c9-b593-d223f7449a82
---
 wp-admin/includes/dashboard.php | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/wp-admin/includes/dashboard.php b/wp-admin/includes/dashboard.php
index a34da20584..19c922667f 100644
--- a/wp-admin/includes/dashboard.php
+++ b/wp-admin/includes/dashboard.php
@@ -1114,7 +1114,15 @@ function wp_dashboard_rss_control( $widget_id, $form_inputs = array() ) {
 	wp_widget_rss_form( $widget_options[$widget_id], $form_inputs );
 }
 
-// Display File upload quota on dashboard
+/**
+ * Display file upload quota on dashboard.
+ *
+ * Runs on the activity_box_end hook in wp_dashboard_right_now().
+ *
+ * @since 3.0.0
+ *
+ * @return bool True if not multisite, user can't upload files, or the space check option is disabled.
+*/
 function wp_dashboard_quota() {
 	if ( !is_multisite() || !current_user_can('upload_files') || get_site_option( 'upload_space_check_disabled' ) )
 		return true;