Add/update doc blocks for MWTidy
authorReedy <reedy@wikimedia.org>
Fri, 29 Jul 2016 00:24:34 +0000 (01:24 +0100)
committerReedy <reedy@wikimedia.org>
Fri, 29 Jul 2016 00:24:34 +0000 (01:24 +0100)
Change-Id: I0b87e119048fd993f8bfda25a6c6b744d59804d1

includes/parser/MWTidy.php

index 46ea773..5e54615 100644 (file)
@@ -41,6 +41,7 @@ class MWTidy {
         * @param string $text HTML input fragment. This should not contain a
         *                     <body> or <html> tag.
         * @return string Corrected HTML output
+        * @throws MWException
         */
        public static function tidy( $text ) {
                $driver = self::singleton();
@@ -57,6 +58,7 @@ class MWTidy {
         * @param string $text
         * @param string &$errorStr Return the error string
         * @return bool Whether the HTML is valid
+        * @throws MWException
         */
        public static function checkErrors( $text, &$errorStr = null ) {
                $driver = self::singleton();
@@ -71,10 +73,16 @@ class MWTidy {
                }
        }
 
+       /**
+        * @return bool
+        */
        public static function isEnabled() {
                return self::singleton() !== false;
        }
 
+       /**
+        * @return bool|\MediaWiki\Tidy\TidyDriverBase
+        */
        protected static function singleton() {
                global $wgUseTidy, $wgTidyInternal, $wgTidyConf, $wgDebugTidy, $wgTidyConfig,
                        $wgTidyBin, $wgTidyOpts;
@@ -110,7 +118,8 @@ class MWTidy {
         * Create a new Tidy driver object from configuration.
         * @see $wgTidyConfig
         * @param array $config
-        * @return TidyDriverBase
+        * @return bool|\MediaWiki\Tidy\TidyDriverBase
+        * @throws MWException
         */
        public static function factory( array $config ) {
                switch ( $config['driver'] ) {
@@ -139,7 +148,7 @@ class MWTidy {
 
        /**
         * Set the driver to be used. This is for testing.
-        * @param TidyDriverBase|false|null $instance
+        * @param MediaWiki\Tidy\TidyDriverBase|false|null $instance
         */
        public static function setInstance( $instance ) {
                self::$instance = $instance;