[MediaWiki-commits] [Gerrit] mediawiki...SemanticGenealogy[master]: Remove obvious, non-helpful documentation snippets
jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/400574 )
Change subject: Remove obvious, non-helpful documentation snippets
..
Remove obvious, non-helpful documentation snippets
Describing a parameter as "the parameter" does not add anything. It's
actually worse than having no documentation, because one must read it
first to understand it doesn't explain anything.
Change-Id: Icc54ee733d19e56efc5a63417307d948064825f5
---
M Gedcom5FilePrinter.php
M Gedcom5ResultPrinter.php
M PersonPageValues.php
M Tools.php
M src/Tree/DescendantListFamilyTree.php
M src/Tree/FamilyTree.php
M src/Tree/LinkFamilyTree.php
7 files changed, 19 insertions(+), 33 deletions(-)
Approvals:
jenkins-bot: Verified
Tpt: Looks good to me, approved
diff --git a/Gedcom5FilePrinter.php b/Gedcom5FilePrinter.php
index 47b3787..c509ebd 100644
--- a/Gedcom5FilePrinter.php
+++ b/Gedcom5FilePrinter.php
@@ -151,7 +151,7 @@
* Add the GEDCOM for a person
*
* @param integer $personId the id of the person
-* @param object $person PersonPageValues object
+* @param PersonPageValues $person
*
* @return void
*/
@@ -202,7 +202,7 @@
/**
* Get the gedcom name
*
-* @param object $person the person object
+* @param PersonPageValues $person
*
* @return string the name for the gedcom
*/
@@ -224,8 +224,8 @@
* Adds a row
*
* @param string $level the level of the row
-* @param string $key the key
-* @param object $value the value
+* @param string $key
+* @param object $value
*
* @return void
*/
@@ -242,9 +242,9 @@
*
* TODO add places metadata support.
*
-* @param string $type the type
-* @param string $date the date
-* @param string $place the place
+* @param string $type
+* @param string $date
+* @param string $place
*
* @return void
*/
@@ -265,7 +265,7 @@
* Adds a row from string value
*
* @param string $level the level of the row
-* @param string $key the key
+* @param string $key
* @param object $value the string value
*
* @return void
@@ -280,7 +280,7 @@
* Adds a row from time value
*
* @param string $level the level of the row
-* @param string $key the key
+* @param string $key
* @param object $value the time value
*
* @return void
@@ -297,7 +297,7 @@
* Adds a row from the wiki page
*
* @param string $level the level of the row
-* @param string $key the key
+* @param string $key
* @param object $value the wiki page value
*
* @return void
diff --git a/Gedcom5ResultPrinter.php b/Gedcom5ResultPrinter.php
index d86e993..6c12d43 100644
--- a/Gedcom5ResultPrinter.php
+++ b/Gedcom5ResultPrinter.php
@@ -41,7 +41,7 @@
/**
* Get the query mode
*
-* @param string $context the context
+* @param string $context
*
* @return string the query mode
*/
@@ -62,7 +62,7 @@
/**
* Get the result test of the result printer
*
-* @param SMWQueryResult $res the result
+* @param SMWQueryResult $res
* @param integer $outputmode the output mode chosen
*
* @return string the result text
diff --git a/PersonPageValues.php b/PersonPageValues.php
index 93c0c10..8fe5559 100644
--- a/PersonPageValues.php
+++ b/PersonPageValues.php
@@ -31,7 +31,7 @@
/**
* Constructor for a single indi in the file.
*
-* @param SMWDIWikiPage $page the page
+* @param SMWDIWikiPage $page
*/
public function __construct( SMWDIWikiPage $page ) {
$values = [];
diff --git a/Tools.php b/Tools.php
index f546378..6dcefe6 100644
--- a/Tools.php
+++ b/Tools.php
@@ -7,8 +7,8 @@
/**
* Find the subclasses of that superclass in one directory
*
-* @param string $dir the directory
-* @param string $superClass the superclass name
+* @param string $dir
+* @param string $superClass
*
* @return array an array of $classes subclass of the superClass
*/
diff --git a/src/Tree/DescendantListFamilyTree.php
b/src/Tree/DescendantListFamilyTree.php
index e6e7490..94bb130 100644
--- a/src/Tree/DescendantListFamilyTree.php
+++ b/src/Tree/DescendantListFamilyTree.php
@@ -18,7 +18,7 @@
/**
* List the descendants for all needed generations
*
-* @param PersonPageValues $person the person object
+* @param PersonPageValues $person
* @param string
[MediaWiki-commits] [Gerrit] mediawiki...SemanticGenealogy[master]: Remove obvious, non-helpful documentation snippets
Thiemo Kreuz (WMDE) has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/400574 )
Change subject: Remove obvious, non-helpful documentation snippets
..
Remove obvious, non-helpful documentation snippets
Describing a parameter as "the parameter" does not add anything. It's
actually worse than having no documentation, because one must read it
first to understand it doesn't explain anything.
Change-Id: Icc54ee733d19e56efc5a63417307d948064825f5
---
M Gedcom5FilePrinter.php
M Gedcom5ResultPrinter.php
M PersonPageValues.php
M Tools.php
M src/Tree/DescendantListFamilyTree.php
M src/Tree/FamilyTree.php
M src/Tree/LinkFamilyTree.php
7 files changed, 19 insertions(+), 33 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/SemanticGenealogy
refs/changes/74/400574/1
diff --git a/Gedcom5FilePrinter.php b/Gedcom5FilePrinter.php
index 47b3787..c509ebd 100644
--- a/Gedcom5FilePrinter.php
+++ b/Gedcom5FilePrinter.php
@@ -151,7 +151,7 @@
* Add the GEDCOM for a person
*
* @param integer $personId the id of the person
-* @param object $person PersonPageValues object
+* @param PersonPageValues $person
*
* @return void
*/
@@ -202,7 +202,7 @@
/**
* Get the gedcom name
*
-* @param object $person the person object
+* @param PersonPageValues $person
*
* @return string the name for the gedcom
*/
@@ -224,8 +224,8 @@
* Adds a row
*
* @param string $level the level of the row
-* @param string $key the key
-* @param object $value the value
+* @param string $key
+* @param object $value
*
* @return void
*/
@@ -242,9 +242,9 @@
*
* TODO add places metadata support.
*
-* @param string $type the type
-* @param string $date the date
-* @param string $place the place
+* @param string $type
+* @param string $date
+* @param string $place
*
* @return void
*/
@@ -265,7 +265,7 @@
* Adds a row from string value
*
* @param string $level the level of the row
-* @param string $key the key
+* @param string $key
* @param object $value the string value
*
* @return void
@@ -280,7 +280,7 @@
* Adds a row from time value
*
* @param string $level the level of the row
-* @param string $key the key
+* @param string $key
* @param object $value the time value
*
* @return void
@@ -297,7 +297,7 @@
* Adds a row from the wiki page
*
* @param string $level the level of the row
-* @param string $key the key
+* @param string $key
* @param object $value the wiki page value
*
* @return void
diff --git a/Gedcom5ResultPrinter.php b/Gedcom5ResultPrinter.php
index d86e993..6c12d43 100644
--- a/Gedcom5ResultPrinter.php
+++ b/Gedcom5ResultPrinter.php
@@ -41,7 +41,7 @@
/**
* Get the query mode
*
-* @param string $context the context
+* @param string $context
*
* @return string the query mode
*/
@@ -62,7 +62,7 @@
/**
* Get the result test of the result printer
*
-* @param SMWQueryResult $res the result
+* @param SMWQueryResult $res
* @param integer $outputmode the output mode chosen
*
* @return string the result text
diff --git a/PersonPageValues.php b/PersonPageValues.php
index 93c0c10..8fe5559 100644
--- a/PersonPageValues.php
+++ b/PersonPageValues.php
@@ -31,7 +31,7 @@
/**
* Constructor for a single indi in the file.
*
-* @param SMWDIWikiPage $page the page
+* @param SMWDIWikiPage $page
*/
public function __construct( SMWDIWikiPage $page ) {
$values = [];
diff --git a/Tools.php b/Tools.php
index f546378..6dcefe6 100644
--- a/Tools.php
+++ b/Tools.php
@@ -7,8 +7,8 @@
/**
* Find the subclasses of that superclass in one directory
*
-* @param string $dir the directory
-* @param string $superClass the superclass name
+* @param string $dir
+* @param string $superClass
*
* @return array an array of $classes subclass of the superClass
*/
diff --git a/src/Tree/DescendantListFamilyTree.php
b/src/Tree/DescendantListFamilyTree.php
index e6e7490..94bb130 100644
--- a/src/Tree/DescendantListFamilyTree.php
+++ b/src/Tree/DescendantListFamilyTree.php
@@ -18,7 +18,7 @@
/**
* List the descendants for all needed generations
*
-* @param PersonPageValues $person the person object
+* @param PersonPageValues
