From 320d4e1374a7d3db1c4babaefba2614e234a0bae Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Sun, 15 Aug 2010 17:27:41 +0000
Subject: [PATCH] * Standardised file description headers * Added some
 descriptions

---
 includes/media/BMP.php                  |  2 ++
 includes/media/Bitmap.php               |  4 ++++
 includes/media/Bitmap_ClientOnly.php    | 14 ++++++++++++++
 includes/media/DjVu.php                 |  4 ++++
 includes/media/GIF.php                  |  2 ++
 includes/media/GIFMetadataExtractor.php | 21 +++++++++++++++------
 includes/media/Generic.php              |  1 +
 includes/media/MediaTransformOutput.php |  2 ++
 includes/media/PNG.php                  |  2 ++
 includes/media/PNGMetadataExtractor.php | 18 +++++++++++++-----
 includes/media/SVG.php                  |  4 ++++
 includes/media/Tiff.php                 |  4 ++++
 12 files changed, 67 insertions(+), 11 deletions(-)

diff --git a/includes/media/BMP.php b/includes/media/BMP.php
index 89c763a729..de836b595d 100644
--- a/includes/media/BMP.php
+++ b/includes/media/BMP.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Handler for Microsoft's bitmap format
+ *
  * @file
  * @ingroup Media
  */
diff --git a/includes/media/Bitmap.php b/includes/media/Bitmap.php
index 5a64b32238..170c0c5455 100644
--- a/includes/media/Bitmap.php
+++ b/includes/media/Bitmap.php
@@ -1,10 +1,14 @@
 <?php
 /**
+ * Generic handler for bitmap images
+ *
  * @file
  * @ingroup Media
  */
 
 /**
+ * Generic handler for bitmap images
+ *
  * @ingroup Media
  */
 class BitmapHandler extends ImageHandler {
diff --git a/includes/media/Bitmap_ClientOnly.php b/includes/media/Bitmap_ClientOnly.php
index d14876c750..4cbc407be8 100644
--- a/includes/media/Bitmap_ClientOnly.php
+++ b/includes/media/Bitmap_ClientOnly.php
@@ -1,5 +1,19 @@
 <?php
+/**
+ * Handler for bitmap images that will be resized by clients
+ *
+ * @file
+ * @ingroup Media
+ */
 
+/**
+ * Handler for bitmap images that will be resized by clients.
+ *
+ * This is not used by default but can be assigned to some image types
+ * using $wgMediaHandlers.
+ *
+ * @ingroup Media
+ */
 class BitmapHandler_ClientOnly extends BitmapHandler {
 	function normaliseParams( $image, &$params ) {
 		return parent::normaliseParams( $image, $params );
diff --git a/includes/media/DjVu.php b/includes/media/DjVu.php
index 0812ae5fc5..73b73a22c2 100644
--- a/includes/media/DjVu.php
+++ b/includes/media/DjVu.php
@@ -1,10 +1,14 @@
 <?php
 /**
+ * Handler for DjVu images
+ *
  * @file
  * @ingroup Media
  */
  
 /**
+ * Handler for DjVu images
+ *
  * @ingroup Media
  */
 class DjVuHandler extends ImageHandler {
diff --git a/includes/media/GIF.php b/includes/media/GIF.php
index ed3facba64..70277c7892 100644
--- a/includes/media/GIF.php
+++ b/includes/media/GIF.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Handler for GIF images.
+ *
  * @file
  * @ingroup Media
  */
diff --git a/includes/media/GIFMetadataExtractor.php b/includes/media/GIFMetadataExtractor.php
index fac9012b50..bc1a4804aa 100644
--- a/includes/media/GIFMetadataExtractor.php
+++ b/includes/media/GIFMetadataExtractor.php
@@ -1,12 +1,21 @@
 <?php
 /**
-  * GIF frame counter.
-  * Originally written in Perl by Steve Sanbeg.
-  * Ported to PHP by Andrew Garrett
-  * Deliberately not using MWExceptions to avoid external dependencies, encouraging
-  * redistribution.
-  */
+ * GIF frame counter.
+ *
+ * Originally written in Perl by Steve Sanbeg.
+ * Ported to PHP by Andrew Garrett
+ * Deliberately not using MWExceptions to avoid external dependencies, encouraging
+ * redistribution.
+ *
+ * @file
+ * @ingroup Media
+ */
 
+/**
+ * GIF frame counter.
+ *
+ * @ingroup Media
+ */
 class GIFMetadataExtractor {
 	static $gif_frame_sep;
 	static $gif_extension_sep;
diff --git a/includes/media/Generic.php b/includes/media/Generic.php
index f53ad7bb02..9dbd7e30db 100644
--- a/includes/media/Generic.php
+++ b/includes/media/Generic.php
@@ -1,6 +1,7 @@
 <?php
 /**
  * Media-handling base classes and generic functionality
+ *
  * @file
  * @ingroup Media
  */
diff --git a/includes/media/MediaTransformOutput.php b/includes/media/MediaTransformOutput.php
index 21a3f5d94d..927db9292a 100644
--- a/includes/media/MediaTransformOutput.php
+++ b/includes/media/MediaTransformOutput.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Base class for the output of file transformation methods.
+ *
  * @file
  * @ingroup Media
  */
diff --git a/includes/media/PNG.php b/includes/media/PNG.php
index 21de7f2847..fb912c4130 100644
--- a/includes/media/PNG.php
+++ b/includes/media/PNG.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Handler for PNG images.
+ *
  * @file
  * @ingroup Media
  */
diff --git a/includes/media/PNGMetadataExtractor.php b/includes/media/PNGMetadataExtractor.php
index 2edeca56f7..490abead2d 100644
--- a/includes/media/PNGMetadataExtractor.php
+++ b/includes/media/PNGMetadataExtractor.php
@@ -1,11 +1,19 @@
 <?php
 /**
-  * PNG frame counter.
-  * Slightly derived from GIFMetadataExtractor.php
-  * Deliberately not using MWExceptions to avoid external dependencies, encouraging
-  * redistribution.
-  */
+ * PNG frame counter.
+ * Slightly derived from GIFMetadataExtractor.php
+ * Deliberately not using MWExceptions to avoid external dependencies, encouraging
+ * redistribution.
+ *
+ * @file
+ * @ingroup Media
+ */
 
+/**
+ * PNG frame counter.
+ *
+ * @ingroup Media
+ */
 class PNGMetadataExtractor {
 	static $png_sig;
 	static $CRC_size;
diff --git a/includes/media/SVG.php b/includes/media/SVG.php
index 69a36f31e6..fae30912f9 100644
--- a/includes/media/SVG.php
+++ b/includes/media/SVG.php
@@ -1,10 +1,14 @@
 <?php
 /**
+ * Handler for SVG images.
+ *
  * @file
  * @ingroup Media
  */
 
 /**
+ * Handler for SVG images.
+ *
  * @ingroup Media
  */
 class SvgHandler extends ImageHandler {
diff --git a/includes/media/Tiff.php b/includes/media/Tiff.php
index 859595b585..8773201f76 100644
--- a/includes/media/Tiff.php
+++ b/includes/media/Tiff.php
@@ -1,10 +1,14 @@
 <?php
 /**
+ * Handler for Tiff images.
+ *
  * @file
  * @ingroup Media
  */
 
 /**
+ * Handler for Tiff images.
+ *
  * @ingroup Media
  */
 class TiffHandler extends BitmapHandler {
-- 
2.20.1