From dc50e1a4bfb19be9db8d80bdbdb59e25c703eda1 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Sun, 22 Aug 2010 14:31:05 +0000
Subject: [PATCH] * Added file description headers * Added @file where needed

---
 includes/json/FormatJson.php            |  3 +++
 includes/parser/CoreLinkFunctions.php   |  5 +++++
 includes/parser/CoreParserFunctions.php |  5 +++++
 includes/parser/CoreTagHooks.php        |  9 +++++++++
 includes/parser/DateFormatter.php       |  5 +++++
 includes/parser/LinkHolderArray.php     | 10 +++++++++-
 includes/parser/ParserCache.php         |  6 ++++++
 includes/parser/ParserOptions.php       |  8 +++++++-
 includes/parser/ParserOutput.php        |  7 +++++++
 includes/parser/Parser_DiffTest.php     |  5 +++++
 includes/parser/Parser_LinkHooks.php    |  6 ++++++
 includes/parser/Preprocessor.php        |  5 +++++
 includes/parser/Preprocessor_DOM.php    |  8 +++++++-
 includes/parser/Preprocessor_Hash.php   |  8 +++++++-
 includes/parser/Tidy.php                |  5 +++++
 15 files changed, 91 insertions(+), 4 deletions(-)

diff --git a/includes/json/FormatJson.php b/includes/json/FormatJson.php
index cf49c17bec..57ab165718 100644
--- a/includes/json/FormatJson.php
+++ b/includes/json/FormatJson.php
@@ -1,7 +1,10 @@
 <?php
 /**
  * Simple wrapper for json_econde and json_decode that falls back on Services_JSON class
+ *
+ * @file
  */
+
 if ( !defined( 'MEDIAWIKI' ) ) {
 	die( 1 );
 }
diff --git a/includes/parser/CoreLinkFunctions.php b/includes/parser/CoreLinkFunctions.php
index d6d1188075..913ec22bf5 100644
--- a/includes/parser/CoreLinkFunctions.php
+++ b/includes/parser/CoreLinkFunctions.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Link functions provided by MediaWiki core; experimental
+ *
+ * @file
+ */
 
 /**
  * Various core link functions, registered in Parser::firstCallInit()
diff --git a/includes/parser/CoreParserFunctions.php b/includes/parser/CoreParserFunctions.php
index ba13d2d789..f35d020d88 100644
--- a/includes/parser/CoreParserFunctions.php
+++ b/includes/parser/CoreParserFunctions.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Parser functions provided by MediaWiki core
+ *
+ * @file
+ */
 
 /**
  * Various core parser functions, registered in Parser::firstCallInit()
diff --git a/includes/parser/CoreTagHooks.php b/includes/parser/CoreTagHooks.php
index 422ebaca3d..e028675a97 100644
--- a/includes/parser/CoreTagHooks.php
+++ b/includes/parser/CoreTagHooks.php
@@ -1,5 +1,14 @@
 <?php
+/**
+ * Tag hooks provided by MediaWiki core
+ *
+ * @file
+ */
 
+/**
+ * Various tag hooks, registered in Parser::firstCallInit()
+ * @ingroup Parser
+ */
 class CoreTagHooks {
 	static function register( $parser ) {
 		global $wgRawHtml, $wgUseTeX;
diff --git a/includes/parser/DateFormatter.php b/includes/parser/DateFormatter.php
index 83b609de0c..c1b07db7f2 100644
--- a/includes/parser/DateFormatter.php
+++ b/includes/parser/DateFormatter.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Date formatter
+ *
+ * @file
+ */
 
 /**
  * Date formatter, recognises dates in plain text and formats them accoding to user preferences.
diff --git a/includes/parser/LinkHolderArray.php b/includes/parser/LinkHolderArray.php
index aacbaff2aa..eccbeb915d 100644
--- a/includes/parser/LinkHolderArray.php
+++ b/includes/parser/LinkHolderArray.php
@@ -1,5 +1,13 @@
 <?php
-
+/**
+ * Holder of replacement pairs for wiki links
+ *
+ * @file
+ */
+
+/**
+ * @ingroup Parser
+ */
 class LinkHolderArray {
 	var $internals = array(), $interwikis = array();
 	var $size = 0;
diff --git a/includes/parser/ParserCache.php b/includes/parser/ParserCache.php
index 00665a1ee2..614099f38e 100644
--- a/includes/parser/ParserCache.php
+++ b/includes/parser/ParserCache.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Cache for outputs of the PHP parser
+ *
+ * @file
+ */
+
 /**
  * @ingroup Cache Parser
  * @todo document
diff --git a/includes/parser/ParserOptions.php b/includes/parser/ParserOptions.php
index 6f6e2dfadd..36c3f36f5b 100644
--- a/includes/parser/ParserOptions.php
+++ b/includes/parser/ParserOptions.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Options for the PHP parser
+ *
+ * @file
+ * @ingroup Parser
+ */
+ 
 /**
  * Set options of the Parser
  * @todo document
diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php
index 38671fb099..dc9b124804 100644
--- a/includes/parser/ParserOutput.php
+++ b/includes/parser/ParserOutput.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * Output of the PHP parser
+ *
+ * @file
+ * @ingroup Parser
+ */
+ 
 /**
  * @todo document
  * @ingroup Parser
diff --git a/includes/parser/Parser_DiffTest.php b/includes/parser/Parser_DiffTest.php
index 608c883a91..8179cc6ea1 100644
--- a/includes/parser/Parser_DiffTest.php
+++ b/includes/parser/Parser_DiffTest.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Fake parser that output the difference of two different parsers
+ *
+ * @file
+ */
 
 /**
  * @ingroup Parser
diff --git a/includes/parser/Parser_LinkHooks.php b/includes/parser/Parser_LinkHooks.php
index 893bf23db7..5d6ac78267 100644
--- a/includes/parser/Parser_LinkHooks.php
+++ b/includes/parser/Parser_LinkHooks.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Modified version of the PHP parser with hooks for wiki links; experimental
+ *
+ * @file
+ */
+
 /**
  * Parser with LinkHooks experiment
  * @ingroup Parser
diff --git a/includes/parser/Preprocessor.php b/includes/parser/Preprocessor.php
index d8c3d851c8..c31f37bf36 100644
--- a/includes/parser/Preprocessor.php
+++ b/includes/parser/Preprocessor.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Interfaces for preprocessors
+ *
+ * @file
+ */
 
 /**
  * @ingroup Parser
diff --git a/includes/parser/Preprocessor_DOM.php b/includes/parser/Preprocessor_DOM.php
index ae33901146..9657ada9f2 100644
--- a/includes/parser/Preprocessor_DOM.php
+++ b/includes/parser/Preprocessor_DOM.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Preprocessor using PHP's dom extension
+ *
+ * @file
+ * @ingroup Parser
+ */
+ 
 /**
  * @ingroup Parser
  */
diff --git a/includes/parser/Preprocessor_Hash.php b/includes/parser/Preprocessor_Hash.php
index d8eff78b00..98630e9ddb 100644
--- a/includes/parser/Preprocessor_Hash.php
+++ b/includes/parser/Preprocessor_Hash.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Preprocessor using PHP arrays
+ *
+ * @file
+ * @ingroup Parser
+ */
+ 
 /**
  * Differences from DOM schema:
  *   * attribute nodes are children
diff --git a/includes/parser/Tidy.php b/includes/parser/Tidy.php
index a4bd19b63a..3e436c8539 100644
--- a/includes/parser/Tidy.php
+++ b/includes/parser/Tidy.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * HTML validation and correction
+ *
+ * @file
+ */
 
 /**
  * Class to interact with HTML tidy
-- 
2.20.1