Wilkins has uploaded a new change for review.
https://gerrit.wikimedia.org/r/245908
Change subject: Syntax and documentation (to be continued...)
......................................................................
Syntax and documentation (to be continued...)
Change-Id: I0a21fb890964e7376162b84cb11643d4b8338a84
---
M AncestorsFamilyTree.php
M DescendantFamilyTree.php
M FamilyTreeFactory.php
M FamilyTreeTag.php
M Gedcom5FilePrinter.php
M Gedcom5ResultPrinter.php
M GenealogicalFilePrinter.php
M PersonPageValues.php
M RelationFamilyTree.php
M SemanticGenealogy.alias.php
M SemanticGenealogy.body.php
M SemanticGenealogy.php
12 files changed, 85 insertions(+), 38 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/SemanticGenealogy
refs/changes/08/245908/1
diff --git a/AncestorsFamilyTree.php b/AncestorsFamilyTree.php
index 25ff254..3ebc623 100644
--- a/AncestorsFamilyTree.php
+++ b/AncestorsFamilyTree.php
@@ -5,12 +5,12 @@
*
* Handle a FamilyTree to display the ancestors of the person
*
- * @file AncestorsFamilyTree.php
+ * @file AncestorsFamilyTree.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
- * @author Thibault Taillandier < thiba...@taillandier.name >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
+ * @author Thibault Taillandier <thiba...@taillandier.name>
*/
class AncestorsFamilyTree extends FamilyTree
{
diff --git a/DescendantFamilyTree.php b/DescendantFamilyTree.php
index 36c21e4..218e269 100644
--- a/DescendantFamilyTree.php
+++ b/DescendantFamilyTree.php
@@ -5,12 +5,12 @@
*
* Handle a FamilyTree to display the descendants of a person
*
- * @file DescendantFamilyTree.php
+ * @file DescendantFamilyTree.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
- * @author Thibault Taillandier < thiba...@taillandier.name >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
+ * @author Thibault Taillandier <thiba...@taillandier.name>
*/
class DescendantFamilyTree extends FamilyTree
{
diff --git a/FamilyTreeFactory.php b/FamilyTreeFactory.php
index 563c485..f3bcac7 100644
--- a/FamilyTreeFactory.php
+++ b/FamilyTreeFactory.php
@@ -1,9 +1,26 @@
<?php
-
+/**
+ * FamilyTreeFactory object
+ *
+ * Create a FamilyTree subclass object from the given type
+ *
+ * @file FamilyTreeFactory.php
+ * @ingroup SemanticGenealogy
+ *
+ * @licence GNU GPL v2+
+ * @author Thibault Taillandier <thiba...@taillandier.name>
+ */
class FamilyTreeFactory
{
+ /**
+ * Create a new FamilyTree object
+ *
+ * @param string $type the type of the wanted FamilyTree
+ *
+ * @return object a new FamilyTree Object
+ */
public static function create($type)
{
switch($type) {
@@ -19,6 +36,5 @@
default:
$output->addWikiText('<span class="error">' .
wfMsg('semanticgenealogy-specialfamilytree-error-unknowntype', $type) .
'</span>');
}
-
}
}
diff --git a/FamilyTreeTag.php b/FamilyTreeTag.php
index f89ae18..d4e34ab 100644
--- a/FamilyTreeTag.php
+++ b/FamilyTreeTag.php
@@ -5,11 +5,11 @@
*
* Handle the <familytree> tag using a FamilyTree object
*
- * @file FamilyTreeTag.php
+ * @file FamilyTreeTag.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thibault Taillandier < thiba...@taillandier.name >
+ * @author Thibault Taillandier <thiba...@taillandier.name>
*/
class FamilyTreeTag
{
@@ -20,7 +20,13 @@
const ATTR_DEPTH = "depth";
const ATTR_TYPE = "type";
- // Hook our callback function into the parser
+ /**
+ * Hook our callback function into the parser
+ *
+ * @param Parser $parser the MW parser
+ *
+ * @return true
+ */
public static function wfFamilytreeParserInit(Parser $parser)
{
// When the parser sees the <familytree> tag, it executes
diff --git a/Gedcom5FilePrinter.php b/Gedcom5FilePrinter.php
index 1e8aa4d..433f629 100644
--- a/Gedcom5FilePrinter.php
+++ b/Gedcom5FilePrinter.php
@@ -1,5 +1,16 @@
<?php
+/**
+ * Gedcom5FilePrinter object
+ *
+ * Generate a GeDCOM file
+ *
+ * @file Gedcom5FilePrinter.php
+ * @ingroup SemanticGenealogy
+ *
+ * @licence GNU GPL v2+
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
+ */
class Gedcom5FilePrinter extends GenealogicalFilePrinter
{
@@ -7,7 +18,9 @@
protected $familiesByPerson = array();
/**
- * set file in $this->file property
+ * Set file in $this->file property
+ *
+ * @return void
*/
protected function setFile()
{
@@ -23,6 +36,11 @@
$this->addRow(0, 'TRLR');
}
+ /**
+ * Set Families List
+ *
+ * @return void
+ */
protected function setFamiliesList()
{
$i = 1;
@@ -84,7 +102,7 @@
}
/**
- * add GEDCOM header
+ * Add GEDCOM header
*/
protected function addHead()
{
@@ -109,8 +127,11 @@
}
/**
- * add the GEDCOM for a person
+ * Add the GEDCOM for a person
+ *
* @param $person PersonPageValues
+ *
+ * @return void
*/
protected function addPerson($id, PersonPageValues $person)
{
diff --git a/Gedcom5ResultPrinter.php b/Gedcom5ResultPrinter.php
index 5e3cceb..48b868e 100644
--- a/Gedcom5ResultPrinter.php
+++ b/Gedcom5ResultPrinter.php
@@ -3,11 +3,11 @@
/**
* Printer class for creating GEDCOM exports
*
- * @file GedcomResultPrinter.php
+ * @file GedcomResultPrinter.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
*/
class Gedcom5ResultPrinter extends SMWResultPrinter
{
diff --git a/GenealogicalFilePrinter.php b/GenealogicalFilePrinter.php
index ab4569b..8348a5c 100644
--- a/GenealogicalFilePrinter.php
+++ b/GenealogicalFilePrinter.php
@@ -3,11 +3,11 @@
/**
* Special page that output genealogical content in some file formats
*
- * @file PersonPageValues.php
+ * @file GenealogicalFilePrinter.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
*/
abstract class GenealogicalFilePrinter
{
@@ -16,7 +16,10 @@
/**
* Add people to the GEDCOM file
+ *
* @param $people array|PersonPageValues
+ *
+ * @return void
*/
public function addPeople($people)
{
@@ -30,6 +33,7 @@
/**
* Return the file
+ *
* @return string
*/
public function getFile()
diff --git a/PersonPageValues.php b/PersonPageValues.php
index d0a8e08..6e6e633 100644
--- a/PersonPageValues.php
+++ b/PersonPageValues.php
@@ -1,13 +1,13 @@
<?php
/**
- * Special page that store genealogical data of a person
+ * Model object that store genealogical data of a person
*
- * @file PersonPageValues.php
+ * @file PersonPageValues.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
*/
class PersonPageValues
{
diff --git a/RelationFamilyTree.php b/RelationFamilyTree.php
index 8df14ac..b740460 100644
--- a/RelationFamilyTree.php
+++ b/RelationFamilyTree.php
@@ -6,12 +6,12 @@
* Handle a FamilyTree to display the relationship between 2 persons.
* Find the closest common ancestor
*
- * @file RelationFamilyTree.php
+ * @file RelationFamilyTree.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
- * @author Thibault Taillandier < thiba...@taillandier.name >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
+ * @author Thibault Taillandier <thiba...@taillandier.name>
*/
class RelationFamilyTree extends FamilyTree
{
@@ -75,9 +75,9 @@
/**
* Compare a generation with a tree
*
- * @param array $gen
- * @param array $tree the tree
- * @param integer $max the max depth
+ * @param array $gen the generation number
+ * @param array $tree the tree
+ * @param integer $max the max depth
*
* @return array an array of 2 SOSA
*/
@@ -105,7 +105,7 @@
* Get the list of ancestors for a sosa number
*
* @param integer $sosa the SOSA number
- * @param array $tree
+ * @param array $tree the ancestors tree
*
* @return array the list of ancestors
*/
diff --git a/SemanticGenealogy.alias.php b/SemanticGenealogy.alias.php
index 6d1632a..d6a58b1 100644
--- a/SemanticGenealogy.alias.php
+++ b/SemanticGenealogy.alias.php
@@ -2,21 +2,21 @@
/**
* Aliases for Special:FamilyTree
*
- * @file SemanticGenealogy.alias.php
+ * @file SemanticGenealogy.alias.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
*/
$specialPageAliases = array();
-/** English (English) */
+/* English (English) */
$specialPageAliases['en'] = array(
- 'FamilyTree' => array( 'FamilyTree' ),
+ 'FamilyTree' => array('FamilyTree'),
);
-/** French (Français) */
+/* French (Français) */
$specialPageAliases['fr'] = array(
- 'FamilyTree' => array( 'ArbreGénéalogique'),
+ 'FamilyTree' => array('ArbreGénéalogique'),
);
diff --git a/SemanticGenealogy.body.php b/SemanticGenealogy.body.php
index 5d23d3e..41c2fd2 100644
--- a/SemanticGenealogy.body.php
+++ b/SemanticGenealogy.body.php
@@ -3,11 +3,11 @@
/**
* Static class for hooks handled by the Semantic Genealogy extension.
*
- * @file SemanticGenealogy.body.php
+ * @file SemanticGenealogy.body.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
*/
class SemanticGenealogy
{
diff --git a/SemanticGenealogy.php b/SemanticGenealogy.php
index 3789f1b..f45577c 100644
--- a/SemanticGenealogy.php
+++ b/SemanticGenealogy.php
@@ -4,11 +4,11 @@
*
* On MediaWiki.org: http://www.mediawiki.org/wiki/Extension:Semantic_Genealogy
*
- * @file SemanticGenealogy.php
+ * @file SemanticGenealogy.php
* @ingroup SemanticGenealogy
*
* @licence GNU GPL v2+
- * @author Thomas Pellissier Tanon < thoma...@hotmail.fr >
+ * @author Thomas Pellissier Tanon <thoma...@hotmail.fr>
*/
/**
--
To view, visit https://gerrit.wikimedia.org/r/245908
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I0a21fb890964e7376162b84cb11643d4b8338a84
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/SemanticGenealogy
Gerrit-Branch: master
Gerrit-Owner: Wilkins <thiba...@taillandier.name>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
