Advanced
Mailing List Archive

Mailing List Archive

  1. Home >
  2. Wikipedia>
  3. Mediawiki-CVS
[MediaWiki-commits] [Gerrit] mediawiki...PageForms[master]: Remove meaningless comments repeating the class name twice
gerrit at wikimedia
Jan 24, 2018, 6:04 AM
Post #1 of 1 (370 views)
Permalink
Thiemo Kreuz (WMDE) has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/406033 )

Change subject: Remove meaningless comments repeating the class name twice
......................................................................

Remove meaningless comments repeating the class name twice

Remove all comments stating the "File holding the … class" as well as
"The … class."

These comments do nothing but repeating the class name. The generated
documentation will state that a file named (for example) Foo.php "holds
the Foo class". In an other place the documentation will state that the
class "Foo" is "the Foo class".

Such comments are worse than having no comments, because I need to read
them to understand they do not hold any additional information, and do
not explain anything. Removing these comments makes room for actual
improvements in the future.

Note there are actual mistakes in some of these comments, e.g. because
the class got renamed, but the comment not updated.

Change-Id: I54ad9ac68684f558228f1b646f97da2c14674ca8
---
M includes/PF_AutoeditAPI.php
M includes/forminputs/PF_CheckboxInput.php
M includes/forminputs/PF_CheckboxesInput.php
M includes/forminputs/PF_ComboBoxInput.php
M includes/forminputs/PF_DateInput.php
M includes/forminputs/PF_DatePickerInput.php
M includes/forminputs/PF_DateTimeInput.php
M includes/forminputs/PF_DateTimePicker.php
M includes/forminputs/PF_DropdownInput.php
M includes/forminputs/PF_EnumInput.php
M includes/forminputs/PF_FormInput.php
M includes/forminputs/PF_GoogleMapsInput.php
M includes/forminputs/PF_LeafletInput.php
M includes/forminputs/PF_ListBoxInput.php
M includes/forminputs/PF_MultiEnumInput.php
M includes/forminputs/PF_OpenLayersInput.php
M includes/forminputs/PF_RadioButtonInput.php
M includes/forminputs/PF_RatingInput.php
M includes/forminputs/PF_RegExpInput.php
M includes/forminputs/PF_TextAreaInput.php
M includes/forminputs/PF_TextAreaWithAutocompleteInput.php
M includes/forminputs/PF_TextInput.php
M includes/forminputs/PF_TextWithAutocompleteInput.php
M includes/forminputs/PF_TimePickerInput.php
M includes/forminputs/PF_TokensInput.php
M includes/forminputs/PF_TreeInput.php
M includes/forminputs/PF_YearInput.php
27 files changed, 0 insertions(+), 102 deletions(-)


git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/PageForms refs/changes/33/406033/1

diff --git a/includes/PF_AutoeditAPI.php b/includes/PF_AutoeditAPI.php
index a403101..d0d9440 100644
--- a/includes/PF_AutoeditAPI.php
+++ b/includes/PF_AutoeditAPI.php
@@ -1,15 +1,11 @@
<?php
/**
- * File holding the PFAutoEditAPI class
- *
* @author Stephan Gambke
* @file
* @ingroup PageForms
*/

/**
- * The PF_AutoEditAPI class.
- *
* @ingroup PageForms
*/
class PFAutoeditAPI extends ApiBase {
diff --git a/includes/forminputs/PF_CheckboxInput.php b/includes/forminputs/PF_CheckboxInput.php
index c5e10b9..e5d89b4 100644
--- a/includes/forminputs/PF_CheckboxInput.php
+++ b/includes/forminputs/PF_CheckboxInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFCheckboxInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFCheckboxInput class.
- *
* @ingroup PFFormInput
*/
class PFCheckboxInput extends PFFormInput {
diff --git a/includes/forminputs/PF_CheckboxesInput.php b/includes/forminputs/PF_CheckboxesInput.php
index 3435e9e..af5333c 100644
--- a/includes/forminputs/PF_CheckboxesInput.php
+++ b/includes/forminputs/PF_CheckboxesInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFCheckboxesInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFCheckboxesInput class.
- *
* @ingroup PFFormInput
*/
class PFCheckboxesInput extends PFMultiEnumInput {
diff --git a/includes/forminputs/PF_ComboBoxInput.php b/includes/forminputs/PF_ComboBoxInput.php
index 2db3a6d..36f97dd 100644
--- a/includes/forminputs/PF_ComboBoxInput.php
+++ b/includes/forminputs/PF_ComboBoxInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFComboBoxInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFComboBoxInput class.
- *
* @ingroup PFFormInput
*/
class PFComboBoxInput extends PFFormInput {
diff --git a/includes/forminputs/PF_DateInput.php b/includes/forminputs/PF_DateInput.php
index 8daf2ba..55decc7 100644
--- a/includes/forminputs/PF_DateInput.php
+++ b/includes/forminputs/PF_DateInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFDateInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFDateInput class.
- *
* @ingroup PFFormInput
*/
class PFDateInput extends PFFormInput {
diff --git a/includes/forminputs/PF_DatePickerInput.php b/includes/forminputs/PF_DatePickerInput.php
index c5d1683..a4b6a50 100644
--- a/includes/forminputs/PF_DatePickerInput.php
+++ b/includes/forminputs/PF_DatePickerInput.php
@@ -1,16 +1,12 @@
<?php

/**
- * File holding the PFDatePickerInput class
- *
* @author Stephan Gambke
* @file
* @ingroup PF
*/

/**
- * The PFDatePickerInput class.
- *
* @ingroup PF
*/
class PFDatePickerInput extends PFFormInput {
diff --git a/includes/forminputs/PF_DateTimeInput.php b/includes/forminputs/PF_DateTimeInput.php
index 07bfc58..2cbfdd8 100644
--- a/includes/forminputs/PF_DateTimeInput.php
+++ b/includes/forminputs/PF_DateTimeInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFDateTimeInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFDateTimeInput class.
- *
* @ingroup PFFormInput
*/
class PFDateTimeInput extends PFDateInput {
diff --git a/includes/forminputs/PF_DateTimePicker.php b/includes/forminputs/PF_DateTimePicker.php
index 7539d54..991402b 100644
--- a/includes/forminputs/PF_DateTimePicker.php
+++ b/includes/forminputs/PF_DateTimePicker.php
@@ -1,16 +1,12 @@
<?php

/**
- * File holding the PFDateTimePicker class
- *
* @author Stephan Gambke
* @file
* @ingroup PageForms
*/

/**
- * The PFDateTimePicker class.
- *
* @ingroup PageForms
*/
class PFDateTimePicker extends PFFormInput {
diff --git a/includes/forminputs/PF_DropdownInput.php b/includes/forminputs/PF_DropdownInput.php
index 6d22961..c1866c3 100644
--- a/includes/forminputs/PF_DropdownInput.php
+++ b/includes/forminputs/PF_DropdownInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFDropdownInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFDropdownInput class.
- *
* @ingroup PFFormInput
*/
class PFDropdownInput extends PFEnumInput {
diff --git a/includes/forminputs/PF_EnumInput.php b/includes/forminputs/PF_EnumInput.php
index 8fce8c9..9e8d078 100644
--- a/includes/forminputs/PF_EnumInput.php
+++ b/includes/forminputs/PF_EnumInput.php
@@ -1,13 +1,10 @@
<?php
/**
- * File holding the PFEnumInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFEnumInput class.
* The base class for every form input that holds a pre-set enumeration
* of values.
*
diff --git a/includes/forminputs/PF_FormInput.php b/includes/forminputs/PF_FormInput.php
index fb449c3..8875cd9 100644
--- a/includes/forminputs/PF_FormInput.php
+++ b/includes/forminputs/PF_FormInput.php
@@ -1,7 +1,5 @@
<?php
/**
- * File holding the PFFormInput class.
- *
* The predecessor of this file held several subclasses of PFFormInput. The
* authors can not be sorted out with certainty anymore, thus are all listed
* here.
diff --git a/includes/forminputs/PF_GoogleMapsInput.php b/includes/forminputs/PF_GoogleMapsInput.php
index f88886c..f41a409 100644
--- a/includes/forminputs/PF_GoogleMapsInput.php
+++ b/includes/forminputs/PF_GoogleMapsInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFGoogleMapsInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFGoogleMapsInput class.
- *
* @ingroup PFFormInput
*/
class PFGoogleMapsInput extends PFOpenLayersInput {
diff --git a/includes/forminputs/PF_LeafletInput.php b/includes/forminputs/PF_LeafletInput.php
index a0266e3..e5cb0ea 100644
--- a/includes/forminputs/PF_LeafletInput.php
+++ b/includes/forminputs/PF_LeafletInput.php
@@ -1,15 +1,11 @@
<?php
/**
- * File holding the PFLeafletInput class
- *
* @author Peter Grassberger
* @file
* @ingroup PF
*/

/**
- * The PFLeafletInput class.
- *
* @ingroup PFFormInput
*/
class PFLeafletInput extends PFOpenLayersInput {
diff --git a/includes/forminputs/PF_ListBoxInput.php b/includes/forminputs/PF_ListBoxInput.php
index 5ab9f90..b6047fd 100644
--- a/includes/forminputs/PF_ListBoxInput.php
+++ b/includes/forminputs/PF_ListBoxInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFListBoxInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFListBoxInput class.
- *
* @ingroup PFFormInput
*/
class PFListBoxInput extends PFMultiEnumInput {
diff --git a/includes/forminputs/PF_MultiEnumInput.php b/includes/forminputs/PF_MultiEnumInput.php
index 284a12a..9bd6bd9 100644
--- a/includes/forminputs/PF_MultiEnumInput.php
+++ b/includes/forminputs/PF_MultiEnumInput.php
@@ -1,13 +1,10 @@
<?php
/**
- * File holding the PFMultiEnumInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFMultiEnumInput class.
* The base class for every form input that holds a list of elements, each
* one from a pre-set enumeration of values.
*
diff --git a/includes/forminputs/PF_OpenLayersInput.php b/includes/forminputs/PF_OpenLayersInput.php
index 1e897d9..efedfab 100644
--- a/includes/forminputs/PF_OpenLayersInput.php
+++ b/includes/forminputs/PF_OpenLayersInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFOpenLayersInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFOpenLayersInput class.
- *
* @ingroup PFFormInput
*/
class PFOpenLayersInput extends PFFormInput {
diff --git a/includes/forminputs/PF_RadioButtonInput.php b/includes/forminputs/PF_RadioButtonInput.php
index 3c2c984..c94c2b2 100644
--- a/includes/forminputs/PF_RadioButtonInput.php
+++ b/includes/forminputs/PF_RadioButtonInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFRadioButtonInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFRadioButtonInput class.
- *
* @ingroup PFFormInput
*/
class PFRadioButtonInput extends PFEnumInput {
diff --git a/includes/forminputs/PF_RatingInput.php b/includes/forminputs/PF_RatingInput.php
index 2afd6e7..26f03b7 100644
--- a/includes/forminputs/PF_RatingInput.php
+++ b/includes/forminputs/PF_RatingInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFRatingInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFRatingInput class.
- *
* @ingroup PFFormInput
*/
class PFRatingInput extends PFFormInput {
diff --git a/includes/forminputs/PF_RegExpInput.php b/includes/forminputs/PF_RegExpInput.php
index 256ae29..a0981ea 100644
--- a/includes/forminputs/PF_RegExpInput.php
+++ b/includes/forminputs/PF_RegExpInput.php
@@ -1,8 +1,6 @@
<?php

/**
- * File holding the PFRegExpInput class
- *
* @author Stephan Gambke
* @file
* @ingroup PF
diff --git a/includes/forminputs/PF_TextAreaInput.php b/includes/forminputs/PF_TextAreaInput.php
index d732f91..6ddb31a 100644
--- a/includes/forminputs/PF_TextAreaInput.php
+++ b/includes/forminputs/PF_TextAreaInput.php
@@ -1,15 +1,11 @@
<?php

/**
- * File holding the PFTextAreaInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFTextAreaInput class.
- *
* @ingroup PFFormInput
*/
class PFTextAreaInput extends PFFormInput {
diff --git a/includes/forminputs/PF_TextAreaWithAutocompleteInput.php b/includes/forminputs/PF_TextAreaWithAutocompleteInput.php
index d276f5d..ea5291f 100644
--- a/includes/forminputs/PF_TextAreaWithAutocompleteInput.php
+++ b/includes/forminputs/PF_TextAreaWithAutocompleteInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFTextAreaWithAutocompleteInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFTextAreaWithAutocompleteInput class.
- *
* @ingroup PFFormInput
*/
class PFTextAreaWithAutocompleteInput extends PFTextAreaInput {
diff --git a/includes/forminputs/PF_TextInput.php b/includes/forminputs/PF_TextInput.php
index f9917da..9b39684 100644
--- a/includes/forminputs/PF_TextInput.php
+++ b/includes/forminputs/PF_TextInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFTextInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFTextInput class.
- *
* @ingroup PFFormInput
*/
class PFTextInput extends PFFormInput {
diff --git a/includes/forminputs/PF_TextWithAutocompleteInput.php b/includes/forminputs/PF_TextWithAutocompleteInput.php
index 52ae584..b5fd7e6 100644
--- a/includes/forminputs/PF_TextWithAutocompleteInput.php
+++ b/includes/forminputs/PF_TextWithAutocompleteInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFTextWithAutocompleteInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFTextWithAutocompleteInput class.
- *
* @ingroup PFFormInput
*/
class PFTextWithAutocompleteInput extends PFTextInput {
diff --git a/includes/forminputs/PF_TimePickerInput.php b/includes/forminputs/PF_TimePickerInput.php
index 5c78aa4..6eb0eb9 100644
--- a/includes/forminputs/PF_TimePickerInput.php
+++ b/includes/forminputs/PF_TimePickerInput.php
@@ -1,16 +1,12 @@
<?php

/**
- * File holding the PFTimePickerInput class
- *
* @author Stephan Gambke
* @file
* @ingroup SemanticFormsInputs
*/

/**
- * The PFTimePickerInput class.
- *
* @ingroup SemanticFormsInputs
*/
class PFTimePickerInput extends PFFormInput {
diff --git a/includes/forminputs/PF_TokensInput.php b/includes/forminputs/PF_TokensInput.php
index 98d1d30..63bf43e 100644
--- a/includes/forminputs/PF_TokensInput.php
+++ b/includes/forminputs/PF_TokensInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFTokensInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFTokensInput class.
- *
* @ingroup PFFormInput
*/
class PFTokensInput extends PFFormInput {
diff --git a/includes/forminputs/PF_TreeInput.php b/includes/forminputs/PF_TreeInput.php
index 617b49e..48db84c 100644
--- a/includes/forminputs/PF_TreeInput.php
+++ b/includes/forminputs/PF_TreeInput.php
@@ -1,7 +1,5 @@
<?php
/**
- * File holding the PFTreeInput class
- *
* @file
* @ingroup PF
*
@@ -10,8 +8,6 @@
*/

/**
- * The PFTreeInput class.
- *
* @ingroup PFFormInput
*/
class PFTreeInput extends PFFormInput {
diff --git a/includes/forminputs/PF_YearInput.php b/includes/forminputs/PF_YearInput.php
index 45e7efe..35c43e3 100644
--- a/includes/forminputs/PF_YearInput.php
+++ b/includes/forminputs/PF_YearInput.php
@@ -1,14 +1,10 @@
<?php
/**
- * File holding the PFYearInput class
- *
* @file
* @ingroup PF
*/

/**
- * The PFYearInput class.
- *
* @ingroup PFFormInput
*/
class PFYearInput extends PFTextInput {

--
To view, visit https://gerrit.wikimedia.org/r/406033
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I54ad9ac68684f558228f1b646f97da2c14674ca8
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/PageForms
Gerrit-Branch: master
Gerrit-Owner: Thiemo Kreuz (WMDE) <thiemo.kreuz@wikimedia.de>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

©2024 GT.net. A Gossamer Threads company.
5th Floor, 455 Granville St., Vancouver, BC V6C 1T1, Canada | Legal