From 4374db281e11a575bfcd66e7ae1366686367831c Mon Sep 17 00:00:00 2001
From: ryan <ryan@1a063a9b-81f0-0310-95a4-ce76da25c4cd>
Date: Fri, 4 Jan 2008 20:05:07 +0000
Subject: [PATCH] Some file level phpdoc from darkdragon. fixes #5572

git-svn-id: http://svn.automattic.com/wordpress/trunk@6554 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/gettext.php                | 10 ++++++++--
 wp-includes/registration-functions.php |  6 +++++-
 wp-includes/rss-functions.php          |  6 +++++-
 wp-includes/streams.php                | 10 ++++++++--
 wp-includes/vars.php                   | 22 ++++++++++++++++++++++
 wp-includes/version.php                | 19 ++++++++++++++++---
 6 files changed, 64 insertions(+), 9 deletions(-)

diff --git a/wp-includes/gettext.php b/wp-includes/gettext.php
index 5b78127c0..48e98b313 100644
--- a/wp-includes/gettext.php
+++ b/wp-includes/gettext.php
@@ -1,5 +1,11 @@
 <?php
-/*
+/**
+ * PHP-Gettext External Library: gettext_reader class
+ *
+ * @package External
+ * @subpackage PHP-gettext
+ *
+ * @internal
 	 Copyright (c) 2003 Danilo Segan <danilo@kvota.net>.
 	 Copyright (c) 2005 Nico Kaiser <nico@siriux.net>
 
@@ -391,4 +397,4 @@ class gettext_reader {
 
 }
 
-?>
+?>
\ No newline at end of file
diff --git a/wp-includes/registration-functions.php b/wp-includes/registration-functions.php
index c597e19e4..a1d5ab54f 100644
--- a/wp-includes/registration-functions.php
+++ b/wp-includes/registration-functions.php
@@ -1,5 +1,9 @@
 <?php
-// Deprecated.  Use registration.php.
+/**
+ * Deprecated. Use registration.php.
+ *
+ * @package WordPress
+ */
 _deprecated_file( basename(__FILE__), '0.0', 'registration.php' );
 require_once(ABSPATH . WPINC .  '/registration.php');
 ?>
diff --git a/wp-includes/rss-functions.php b/wp-includes/rss-functions.php
index 536702305..3ccd75a95 100644
--- a/wp-includes/rss-functions.php
+++ b/wp-includes/rss-functions.php
@@ -1,5 +1,9 @@
 <?php
-// Deprecated.  Use rss.php instead.
+/**
+ * Deprecated.  Use rss.php instead.
+ *
+ * @package WordPress
+ */
 
 _deprecated_file( basename(__FILE__), '0.0', 'rss.php' );
 require_once (ABSPATH . WPINC . '/rss.php');
diff --git a/wp-includes/streams.php b/wp-includes/streams.php
index 0612a5a30..01ff211bb 100644
--- a/wp-includes/streams.php
+++ b/wp-includes/streams.php
@@ -1,5 +1,11 @@
 <?php
-/*
+/**
+ * PHP-Gettext External Library: StreamReader classes
+ *
+ * @package External
+ * @subpackage PHP-gettext
+ *
+ * @internal 
    Copyright (c) 2003, 2005 Danilo Segan <danilo@kvota.net>.
 
    This file is part of PHP-gettext.
@@ -18,7 +24,7 @@
    along with PHP-gettext; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-*/
+ */
 
 
 // Simple class to wrap file streams, string streams, etc.
diff --git a/wp-includes/vars.php b/wp-includes/vars.php
index e01feeae0..77e9ca3e7 100644
--- a/wp-includes/vars.php
+++ b/wp-includes/vars.php
@@ -1,4 +1,16 @@
 <?php
+/**
+ * Creates common globals for the rest of WordPress
+ *
+ * Sets $pagenow global which is the current page. Checks
+ * for the browser to set which one is currently being used.
+ *
+ * Detects which user environment WordPress is being used on.
+ * Only attempts to check for Apache and IIS. Two web servers
+ * with known permalink capability.
+ *
+ * @package WordPress
+ */
 
 // On which page are we ?
 if ( is_admin() ) {
@@ -41,7 +53,17 @@ if (strpos($_SERVER['HTTP_USER_AGENT'], 'Lynx') !== false) {
 $is_IE = ( $is_macIE || $is_winIE );
 
 // Server detection
+
+/**
+ * Whether the server software is Apache or something else
+ * @global bool $is_apache
+ */
 $is_apache = ((strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') !== false) || (strpos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false)) ? true : false;
+
+/**
+ * Whether the server software is IIS or something else
+ * @global bool $is_IIS
+ */
 $is_IIS = (strpos($_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS') !== false) ? true : false;
 
 ?>
\ No newline at end of file
diff --git a/wp-includes/version.php b/wp-includes/version.php
index 19440882d..980dae2d1 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -1,8 +1,21 @@
 <?php
+/**
+ * This holds the version number in a separate file so we can bump it without cluttering the SVN
+ */
 
-// This holds the version number in a separate file so we can bump it without cluttering the SVN
-
+/**
+ * The WordPress version string
+ *
+ * @global string $wp_version
+ */
 $wp_version = '2.4-bleeding';
+
+/**
+ * Holds the WordPress DB revision, increments when changes are made to the WordPress DB scheme
+ * changes.
+ *
+ * @global int $wp_db_version
+ */
 $wp_db_version = 6124;
 
-?>
+?>
\ No newline at end of file