jenkins-bot has submitted this change and it was merged.
Change subject: Add/update doc blocks for MWTidy
......................................................................
Add/update doc blocks for MWTidy
Change-Id: I0b87e119048fd993f8bfda25a6c6b744d59804d1
---
M includes/parser/MWTidy.php
1 file changed, 11 insertions(+), 2 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/parser/MWTidy.php b/includes/parser/MWTidy.php
index 46ea773..5e54615 100644
--- a/includes/parser/MWTidy.php
+++ b/includes/parser/MWTidy.php
@@ -41,6 +41,7 @@
* @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 @@
* @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 @@
}
}
+ /**
+ * @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 @@
* 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 @@
/**
* 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;
--
To view, visit https://gerrit.wikimedia.org/r/301733
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I0b87e119048fd993f8bfda25a6c6b744d59804d1
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Reedy <re...@wikimedia.org>
Gerrit-Reviewer: Legoktm <legoktm.wikipe...@gmail.com>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
