Merge "Warn if stateful ParserOutput transforms are used"
[lhc/web/wiklou.git] / maintenance / term / MWTerm.php
index c52f07c..ec8aeb0 100644 (file)
  *
  * @file
  * @ingroup Maintenance Testing
+ */
+
+/**
+ * @defgroup TermColorer TermColorer
+ * @ingroup Maintenance Testing
  * @todo Fixme: Make this more generic
+ *
+ * Set of classes to help with test output and such. Right now pretty specific
+ * to the parser tests but could be more useful one day :)
  */
 
 /**
  * Terminal that supports ANSI escape sequences.
  *
- * @ingroup Maintenance Testing
+ * @ingroup TermColorer
  */
 class AnsiTermColorer {
        function __construct() {
@@ -35,8 +43,8 @@ class AnsiTermColorer {
        /**
         * Return ANSI terminal escape code for changing text attribs/color
         *
-        * @param $color String: semicolon-separated list of attribute/color codes
-        * @return String
+        * @param string $color Semicolon-separated list of attribute/color codes
+        * @return string
         */
        public function color( $color ) {
                global $wgCommandLineDarkBg;
@@ -49,7 +57,7 @@ class AnsiTermColorer {
        /**
         * Return ANSI terminal escape code for restoring default text attributes
         *
-        * @return String
+        * @return string
         */
        public function reset() {
                return $this->color( 0 );
@@ -59,7 +67,7 @@ class AnsiTermColorer {
 /**
  * A colour-less terminal
  *
- * @ingroup Maintenance Testing
+ * @ingroup TermColorer
  */
 class DummyTermColorer {
        public function color( $color ) {