wikimedia/mediawiki-extensions-Math
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Math synced 2024-11-15 03:34:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove non-helpful comments

Browse source 
Documenting protected members as protected members is not really helpful.
One can see this by looking at the code.

Same for documenting a variable named "$html…" as "HTML". This does not
add anything.

Change-Id: I72364b6857166d77b9c85aa884cd139dc163c6bb
This commit is contained in:
Thiemo Kreuz 2018-04-13 15:32:05 +02:00
parent 82e4283f02
commit 3f0398e031
5 changed files with 2 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
MathChemSymbolsDataModule.php
View file

@ -10,13 +10,9 @@
class MathChemSymbolsDataModule extends ResourceLoaderModule { class MathChemSymbolsDataModule extends ResourceLoaderModule {
/* Protected Members */
protected $origin = self::ORIGIN_USER_SITEWIDE; protected $origin = self::ORIGIN_USER_SITEWIDE;
protected $targets = [ 'desktop', 'mobile' ]; protected $targets = [ 'desktop', 'mobile' ];
/* Methods */
public function getScript( ResourceLoaderContext $context ) { public function getScript( ResourceLoaderContext $context ) {
return 've.ui.MWChemDialog.static.setSymbols(' . return 've.ui.MWChemDialog.static.setSymbols(' .
file_get_contents( __DIR__ . '/modules/ve-math/chemSymbols.json' ) . file_get_contents( __DIR__ . '/modules/ve-math/chemSymbols.json' ) .

4
MathFormatter.php
View file

@ -80,8 +80,8 @@ class MathFormatter implements ValueFormatter {
/** /**
* Constructs a detailed HTML rendering for use in diff views. * Constructs a detailed HTML rendering for use in diff views.
* *
* @param string $valueHtml HTML * @param string $valueHtml
* @param string $tex TeX * @param string $tex
* *
* @return string HTML * @return string HTML
*/ */

4
MathMathSymbolsDataModule.php
View file

@ -10,13 +10,9 @@
class MathMathSymbolsDataModule extends ResourceLoaderModule { class MathMathSymbolsDataModule extends ResourceLoaderModule {
/* Protected Members */
protected $origin = self::ORIGIN_USER_SITEWIDE; protected $origin = self::ORIGIN_USER_SITEWIDE;
protected $targets = [ 'desktop', 'mobile' ]; protected $targets = [ 'desktop', 'mobile' ];
/* Methods */
public function getScript( ResourceLoaderContext $context ) { public function getScript( ResourceLoaderContext $context ) {
return 've.ui.MWMathDialog.static.setSymbols(' . return 've.ui.MWMathDialog.static.setSymbols(' .
file_get_contents( __DIR__ . '/modules/ve-math/mathSymbols.json' ) . file_get_contents( __DIR__ . '/modules/ve-math/mathSymbols.json' ) .

2
MathRenderer.php
View file

@ -121,7 +121,6 @@ abstract class MathRenderer {
} }
/** /**
*
* @param string $md5 * @param string $md5
* @return MathRenderer the MathRenderer generated from md5 * @return MathRenderer the MathRenderer generated from md5
*/ */
@ -555,7 +554,6 @@ abstract class MathRenderer {
} }
/** /**
*
* @param string $mathStyle ('inlineDisplaystyle'|'display'|'inline') * @param string $mathStyle ('inlineDisplaystyle'|'display'|'inline')
*/ */
public function setMathStyle( $mathStyle = 'display' ) { public function setMathStyle( $mathStyle = 'display' ) {

1
tests/MathMLRdfBuilderTest.php
View file

@ -34,7 +34,6 @@ class MathMLRdfBuilderTest extends MediaWikiTestCase {
} }
/** /**
*
* @param string $test * @param string $test
* @return string * @return string
*/ */