jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/382977 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I40589bae00401a5fb253d0261f0f4d881ae37084
---
M ResourceLoaderSyntaxHighlightVisualEditorModule.php
M SyntaxHighlight.class.php
M phpcs.xml
3 files changed, 13 insertions(+), 11 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
jenkins-bot: Verified
diff --git a/ResourceLoaderSyntaxHighlightVisualEditorModule.php
b/ResourceLoaderSyntaxHighlightVisualEditorModule.php
index 8fd24ca..d69b270 100644
--- a/ResourceLoaderSyntaxHighlightVisualEditorModule.php
+++ b/ResourceLoaderSyntaxHighlightVisualEditorModule.php
@@ -48,13 +48,15 @@
/**
* Don't break debug mode by only showing file URLs
+ * @param ResourceLoaderContext $context
+ * @return array
*/
public function getScriptURLsForDebug( ResourceLoaderContext $context )
{
return ResourceLoaderModule::getScriptURLsForDebug( $context );
}
/**
- * Get a full list of available langauges
+ * Get a full list of available languages
* @return array
*/
private function getPygmentsLanguages() {
diff --git a/SyntaxHighlight.class.php b/SyntaxHighlight.class.php
index 4674821..35f7db5 100644
--- a/SyntaxHighlight.class.php
+++ b/SyntaxHighlight.class.php
@@ -82,7 +82,7 @@
/**
* Register parser hook
*
- * @param $parser Parser
+ * @param Parser &$parser
*/
public static function onParserFirstCallInit( Parser &$parser ) {
foreach ( [ 'source', 'syntaxhighlight' ] as $tag ) {
@@ -378,8 +378,8 @@
/**
* Validate a provided input range
- * @param $start
- * @param $end
+ * @param int $start
+ * @param int $end
* @return bool
*/
protected static function validHighlightRange( $start, $end ) {
@@ -400,6 +400,12 @@
* Hook into Content::getParserOutput to provide syntax highlighting for
* script content.
*
+ * @param Content $content
+ * @param Title $title
+ * @param int $revId
+ * @param ParserOptions $options
+ * @param bool $generateHtml
+ * @param ParserOutput &$output
* @return bool
* @since MW 1.21
*/
@@ -489,7 +495,7 @@
* Conditionally register resource loader modules that depends on the
* VisualEditor MediaWiki extension.
*
- * @param ResourceLoader $resourceLoader
+ * @param ResourceLoader &$resourceLoader
*/
public static function onResourceLoaderRegisterModules(
&$resourceLoader ) {
if ( ! ExtensionRegistry::getInstance()->isLoaded(
'VisualEditor' ) ) {
diff --git a/phpcs.xml b/phpcs.xml
index c6aa265..b66f9ed 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -3,10 +3,6 @@
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.WrongCase"
/>
<exclude
name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName"/>
@@ -15,6 +11,4 @@
<file>.</file>
<arg name="extensions" value="php,php5,inc"/>
<arg name="encoding" value="UTF-8"/>
- <exclude-pattern>vendor</exclude-pattern>
- <exclude-pattern>node_modules</exclude-pattern>
</ruleset>
--
To view, visit https://gerrit.wikimedia.org/r/382977
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I40589bae00401a5fb253d0261f0f4d881ae37084
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/SyntaxHighlight_GeSHi
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Legoktm <lego...@member.fsf.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
