Ticket #5233: update.phpdoc.diff

update.php

@@ -1 +1 @@
 <?php
+/**
+ * A simple set of functions to check our version 1.0 update service
+ *
+ * @package WordPress
+ * @since 2.3
+ */
 
-// A simple set of functions to check our version 1.0 update service
-
+/**
+ * Check WordPress version against the newest version at api.wordpress.org server.
+ *
+ * The WordPress version, PHP version, and Locale. If you do not want this behavior, there
+ * exists a plugin called {@link http://wordpress.org/extend/plugins/tinfoil-hat/ Tin Foil Hat}
+ * that will disable this behavior.
+ *
+ * This will also disable the behavior.
+ * <code>
+ * remove_action('init', 'wp_version_check');
+ * </code>
+ *
+ * @package WordPress
+ * @since 2.3
+ * @uses $wp_version Used to check against the newest WordPress version.
+ *
+ * @return mixed Returns null if server doesn't support fsockopen or if WordPress is installing.
+ *              Returns false if the time between last check and current check is too short.
+ */
 function wp_version_check() {
         if ( !function_exists('fsockopen') || strpos($_SERVER['PHP_SELF'], 'install.php') !== false || defined('WP_INSTALLING') )
                 return;