From ddf601f7d31dbfa069fa9d097bb9bed9bfa00f9f Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex.wiki@gmail.com>
Date: Thu, 20 Dec 2012 20:44:47 +0100
Subject: [PATCH] Improve documentation of content handler stuff

- Split file and class documentation
- Add some missing file/class descriptions
- Add missing @ingroup Content

Change-Id: I7f7e3056570ca13a92f36a408c9b961c938f09a1
---
 includes/content/AbstractContent.php          |  6 +++
 includes/content/Content.php                  |  6 +++
 includes/content/ContentHandler.php           | 53 +++++++++++--------
 includes/content/CssContent.php               |  8 +++
 includes/content/CssContentHandler.php        |  6 +++
 includes/content/JavaScriptContent.php        | 11 +++-
 includes/content/JavaScriptContentHandler.php |  8 ++-
 includes/content/MessageContent.php           | 16 ++++--
 includes/content/TextContent.php              | 11 ++--
 includes/content/TextContentHandler.php       |  9 +++-
 includes/content/WikitextContent.php          |  8 +++
 includes/content/WikitextContentHandler.php   |  9 +++-
 12 files changed, 114 insertions(+), 37 deletions(-)

diff --git a/includes/content/AbstractContent.php b/includes/content/AbstractContent.php
index 386f55aee50..cab65a5f4c5 100644
--- a/includes/content/AbstractContent.php
+++ b/includes/content/AbstractContent.php
@@ -25,6 +25,12 @@
  *
  * @author Daniel Kinzler
  */
+
+/**
+ * Base implementation for content objects.
+ *
+ * @ingroup Content
+ */
 abstract class AbstractContent implements Content {
 
 	/**
diff --git a/includes/content/Content.php b/includes/content/Content.php
index 35b51c346f9..75ac5f2993a 100644
--- a/includes/content/Content.php
+++ b/includes/content/Content.php
@@ -25,6 +25,12 @@
  *
  * @author Daniel Kinzler
  */
+
+/**
+ * Base interface for content objects.
+ *
+ * @ingroup Content
+ */
 interface Content {
 
 	/**
diff --git a/includes/content/ContentHandler.php b/includes/content/ContentHandler.php
index cff49dfab73..2e9052854eb 100644
--- a/includes/content/ContentHandler.php
+++ b/includes/content/ContentHandler.php
@@ -1,28 +1,6 @@
 <?php
-
 /**
- * Exception representing a failure to serialize or unserialize a content object.
- */
-class MWContentSerializationException extends MWException {
-
-}
-
-/**
- * A content handler knows how do deal with a specific type of content on a wiki
- * page. Content is stored in the database in a serialized form (using a
- * serialization format a.k.a. MIME type) and is unserialized into its native
- * PHP representation (the content model), which is wrapped in an instance of
- * the appropriate subclass of Content.
- *
- * ContentHandler instances are stateless singletons that serve, among other
- * things, as a factory for Content objects. Generally, there is one subclass
- * of ContentHandler and one subclass of Content for every type of content model.
- *
- * Some content types have a flat model, that is, their native representation
- * is the same as their serialized form. Examples would be JavaScript and CSS
- * code. As of now, this also applies to wikitext (MediaWiki's default content
- * type), but wikitext content may be represented by a DOM or AST structure in
- * the future.
+ * Base class for content handling.
  *
  * 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
@@ -46,6 +24,35 @@ class MWContentSerializationException extends MWException {
  *
  * @author Daniel Kinzler
  */
+
+/**
+ * Exception representing a failure to serialize or unserialize a content object.
+ *
+ * @ingroup Content
+ */
+class MWContentSerializationException extends MWException {
+
+}
+
+/**
+ * A content handler knows how do deal with a specific type of content on a wiki
+ * page. Content is stored in the database in a serialized form (using a
+ * serialization format a.k.a. MIME type) and is unserialized into its native
+ * PHP representation (the content model), which is wrapped in an instance of
+ * the appropriate subclass of Content.
+ *
+ * ContentHandler instances are stateless singletons that serve, among other
+ * things, as a factory for Content objects. Generally, there is one subclass
+ * of ContentHandler and one subclass of Content for every type of content model.
+ *
+ * Some content types have a flat model, that is, their native representation
+ * is the same as their serialized form. Examples would be JavaScript and CSS
+ * code. As of now, this also applies to wikitext (MediaWiki's default content
+ * type), but wikitext content may be represented by a DOM or AST structure in
+ * the future.
+ *
+ * @ingroup Content
+ */
 abstract class ContentHandler {
 
 	/**
diff --git a/includes/content/CssContent.php b/includes/content/CssContent.php
index 29527cfbd43..3d4eb241fbd 100644
--- a/includes/content/CssContent.php
+++ b/includes/content/CssContent.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Content object for CSS pages.
+ *
  * 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
@@ -22,6 +24,12 @@
  *
  * @author Daniel Kinzler
  */
+
+/**
+ * Content object for CSS pages.
+ *
+ * @ingroup Content
+ */
 class CssContent extends TextContent {
 	public function __construct( $text ) {
 		parent::__construct( $text, CONTENT_MODEL_CSS );
diff --git a/includes/content/CssContentHandler.php b/includes/content/CssContentHandler.php
index 2c68d2f813c..cb5a349d307 100644
--- a/includes/content/CssContentHandler.php
+++ b/includes/content/CssContentHandler.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Content handler for CSS pages.
+ *
  * 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
@@ -16,10 +18,14 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
+ * @ingroup Content
  */
 
 /**
+ * Content handler for CSS pages.
+ *
  * @since 1.21
+ * @ingroup Content
  */
 class CssContentHandler extends TextContentHandler {
 
diff --git a/includes/content/JavaScriptContent.php b/includes/content/JavaScriptContent.php
index 770f2336206..7508079a2ed 100644
--- a/includes/content/JavaScriptContent.php
+++ b/includes/content/JavaScriptContent.php
@@ -1,6 +1,7 @@
 <?php
-
 /**
+ * Content for JavaScript pages.
+ *
  * 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
@@ -23,6 +24,12 @@
  *
  * @author Daniel Kinzler
  */
+
+/**
+ * Content for JavaScript pages.
+ *
+ * @ingroup Content
+ */
 class JavaScriptContent extends TextContent {
 	public function __construct( $text ) {
 		parent::__construct( $text, CONTENT_MODEL_JAVASCRIPT );
@@ -57,4 +64,4 @@ class JavaScriptContent extends TextContent {
 
 		return $html;
 	}
-}
\ No newline at end of file
+}
diff --git a/includes/content/JavaScriptContentHandler.php b/includes/content/JavaScriptContentHandler.php
index b5b4ee254c6..33fa917213b 100644
--- a/includes/content/JavaScriptContentHandler.php
+++ b/includes/content/JavaScriptContentHandler.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Content handler for JavaScript pages.
+ *
  * 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
@@ -18,10 +20,12 @@
  * @file
  */
 
-# XXX: make ScriptContentHandler base class, do highlighting stuff there?
-
 /**
+ * Content handler for JavaScript pages.
+ *
  * @since 1.21
+ * @ingroup Content
+ * @todo make ScriptContentHandler base class, do highlighting stuff there?
  */
 class JavaScriptContentHandler extends TextContentHandler {
 
diff --git a/includes/content/MessageContent.php b/includes/content/MessageContent.php
index d38355d107a..b36b670c786 100644
--- a/includes/content/MessageContent.php
+++ b/includes/content/MessageContent.php
@@ -1,9 +1,6 @@
 <?php
-
 /**
- * Wrapper allowing us to handle a system message as a Content object. Note that this is generally *not* used
- * to represent content from the MediaWiki namespace, and that there is no MessageContentHandler. MessageContent
- * is just intended as glue for wrapping a message programatically.
+ * Wrapper content object allowing to handle a system message as a Content object.
  *
  * 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
@@ -27,6 +24,15 @@
  *
  * @author Daniel Kinzler
  */
+
+/**
+ * Wrapper allowing us to handle a system message as a Content object.
+ * Note that this is generally *not* used to represent content from the
+ * MediaWiki namespace, and that there is no MessageContentHandler.
+ * MessageContent is just intended as glue for wrapping a message programatically.
+ *
+ * @ingroup Content
+ */
 class MessageContent extends AbstractContent {
 
 	/**
@@ -149,4 +155,4 @@ class MessageContent extends AbstractContent {
 		$po = new ParserOutput( $html );
 		return $po;
 	}
-}
\ No newline at end of file
+}
diff --git a/includes/content/TextContent.php b/includes/content/TextContent.php
index 872738b4fea..0f7a53152c1 100644
--- a/includes/content/TextContent.php
+++ b/includes/content/TextContent.php
@@ -1,10 +1,7 @@
 <?php
-
 /**
  * Content object implementation for representing flat text.
  *
- * TextContent instances are immutable
- *
  * 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
@@ -27,6 +24,14 @@
  *
  * @author Daniel Kinzler
  */
+
+/**
+ * Content object implementation for representing flat text.
+ *
+ * TextContent instances are immutable
+ *
+ * @ingroup Content
+ */
 class TextContent extends AbstractContent {
 
 	public function __construct( $text, $model_id = CONTENT_MODEL_TEXT ) {
diff --git a/includes/content/TextContentHandler.php b/includes/content/TextContentHandler.php
index 90802f6fa0a..e7f41e18b81 100644
--- a/includes/content/TextContentHandler.php
+++ b/includes/content/TextContentHandler.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Base content handler class for flat text contents.
+ *
  * 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
@@ -15,11 +17,16 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @since 1.21
+ *
  * @file
+ * @ingroup Content
  */
 
 /**
- * @since 1.21
+ * Base content handler implementation for flat text contents.
+ *
+ * @ingroup Content
  */
 class TextContentHandler extends ContentHandler {
 
diff --git a/includes/content/WikitextContent.php b/includes/content/WikitextContent.php
index dabb85518da..8d778f53d12 100644
--- a/includes/content/WikitextContent.php
+++ b/includes/content/WikitextContent.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Content object for wiki text pages.
+ *
  * 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
@@ -22,6 +24,12 @@
  *
  * @author Daniel Kinzler
  */
+
+/**
+ * Content object for wiki text pages.
+ *
+ * @ingroup Content
+ */
 class WikitextContent extends TextContent {
 
 	public function __construct( $text ) {
diff --git a/includes/content/WikitextContentHandler.php b/includes/content/WikitextContentHandler.php
index 4ec20ef8e5b..46412a98b4b 100644
--- a/includes/content/WikitextContentHandler.php
+++ b/includes/content/WikitextContentHandler.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Content handler for wiki text pages.
+ *
  * 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
@@ -15,11 +17,16 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @since 1.21
+ *
  * @file
+ * @ingroup Content
  */
 
 /**
- * @since 1.21
+ * Content handler for wiki text pages.
+ *
+ * @ingroup Content
  */
 class WikitextContentHandler extends TextContentHandler {