From ce9c8bf6868ccf80002be484803022ebcc3f4d68 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Sat, 21 Mar 2009 16:48:09 +0000
Subject: [PATCH] Same as r48631; added "@file" when needed, also added doc in
 redirect.php and install-utils.inc

---
 api.php             | 42 ++++++++++++++++++++++--------------------
 img_auth.php        |  6 ++++--
 install-utils.inc   |  7 +++++++
 opensearch_desc.php |  2 ++
 redirect.php        |  8 ++++++++
 5 files changed, 43 insertions(+), 22 deletions(-)

diff --git a/api.php b/api.php
index 817f4bca78..eb223994d0 100644
--- a/api.php
+++ b/api.php
@@ -1,25 +1,27 @@
 <?php
 
-/*
-* API for MediaWiki 1.8+
-*
-* Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
-*
-* This program is free software; you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
-* (at your option) any later version.
-*
-* This program is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-* GNU General Public License for more details.
-*
-* You should have received a copy of the GNU General Public License along
-* with this program; if not, write to the Free Software Foundation, Inc.,
-* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-* http://www.gnu.org/copyleft/gpl.html
-*/
+/**
+ * API for MediaWiki 1.8+
+ *
+ * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /** 
  * This file is the entry point for all API queries. It begins by checking 
diff --git a/img_auth.php b/img_auth.php
index 9141018103..e5d8d8880b 100644
--- a/img_auth.php
+++ b/img_auth.php
@@ -5,11 +5,13 @@
  *
  * To use this:
  *
- * Set $wgUploadDirectory to a non-public directory (not web accessible)
- * Set $wgUploadPath to point to this file
+ * - Set $wgUploadDirectory to a non-public directory (not web accessible)
+ * - Set $wgUploadPath to point to this file
  *
  * Your server needs to support PATH_INFO; CGI-based configurations
  * usually don't.
+ *
+ * @file
  */
  
 define( 'MW_NO_OUTPUT_COMPRESSION', 1 );
diff --git a/install-utils.inc b/install-utils.inc
index 6a99ec5535..ab8e15dc8d 100644
--- a/install-utils.inc
+++ b/install-utils.inc
@@ -1,5 +1,12 @@
 <?php
 
+/**
+ * This file contains functions used by the install script (config/index.php)
+ * and maintenance scripts. It is not loaded in normal web requests.
+ *
+ * @file
+ */
+
 function install_version_checks() {
 	# We dare not turn output buffer _off_ since this will break completely
 	# if PHP is globally configured to run through a gzip filter.
diff --git a/opensearch_desc.php b/opensearch_desc.php
index 3dbf872079..cc6c4719e2 100644
--- a/opensearch_desc.php
+++ b/opensearch_desc.php
@@ -2,6 +2,8 @@
 
 /**
  * Generate an OpenSearch description file
+ *
+ * @file
  */
 
 require_once( dirname(__FILE__) . '/includes/WebStart.php' );
diff --git a/redirect.php b/redirect.php
index 626c30d3bc..699926ec30 100644
--- a/redirect.php
+++ b/redirect.php
@@ -1,4 +1,12 @@
 <?php
+
+/**
+ * Script that redirects to the article passed in the "wpDropdown" parameter.
+ * This is used by the nostalgia skin for the special pages drop-down
+ *
+ * @file
+ */
+
 require_once( './includes/WebStart.php' );
 global $wgArticlePath;
 
-- 
2.20.1