jon48 / webtrees-lib

src/Webtrees/Family.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	/**
 	 * Find the spouse of a person, using the Xref comparison.
 	 *
-	 * @param Individual $person
+	 * @param fw\Individual $person
 	 *
 	 * @return Individual|null
 	 */

src/Webtrees/Functions/FunctionsPrint.php

Doc Comments +1 added lines, -3 removed lines

@@ -74,7 +74,7 @@ 
 	 * 
 	 * @param \Fisharebest\Webtrees\Place $place
 	 * @param string $icon_path
-	 * @param number $size
+	 * @param integer $size
 	 * @return string HTML code of the inserted flag
 	 */
 	public static function htmlPlaceIcon(\Fisharebest\Webtrees\Place $place, $icon_path , $size = 50) {
@@ -184,7 +184,6 @@ 
 	/**
 	 * Format date to display short (just years)
 	 *
-	 * @param \Fisharebest\Webtrees\Fact $eventObj Fact to display date
 	 * @param boolean $anchor option to print a link to calendar
 	 * @return string HTML code for short date
 	 */
@@ -212,7 +211,6 @@ 
 	/**
 	 * Format fact place to display short
 	 *
-	 * @param \Fisharebest\Webtrees\Fact $eventObj Fact to display date
 	 * @param string $format Format of the place
 	 * @param boolean $anchor option to print a link to placelist
 	 * @return string HTML code for short place

src/Webtrees/Individual.php

Doc Comments +1 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
 	 * Returns an estimated birth place based on statistics on the base
 	 *
 	 * @param boolean $perc Should the coefficient of reliability be returned
-	 * @return string|array Estimated birth place if found, null otherwise
+	 * @return string Estimated birth place if found, null otherwise
 	 */
 	public function getEstimatedBirthPlace($perc=false){
 		if($bplace = $this->gedcomrecord->getBirthPlace()){
@@ -110,7 +110,6 @@ 
 	/**
 	 * Returns a significant place for the individual
 	 *
-	 * @param boolean $perc Should the coefficient of reliability be returned
 	 * @return string|array Estimated birth place if found, null otherwise
 	 */
 	public function getSignificantPlace(){

src/Webtrees/Module/AdminTasks/Model/AbstractTask.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
      * Set parameters of the Task
      *
      * @param bool $is_enabled Status of the task
-     * @param \DateTime $lastupdated Time of the last task run
+     * @param \DateTime $last_updated Time of the last task run
      * @param bool $last_result Result of the last run, true for success, false for failure
      * @param int $frequency Frequency of execution in minutes
      * @param int $nb_occur Number of remaining occurrences, 0 for tasks not limited

src/Webtrees/Module/AdminTasks/Model/TaskProviderInterface.php

Doc Comments +3 added lines, -2 removed lines

@@ -32,8 +32,8 @@ 
 	 * Set the status of a specific admin task.
 	 * The status can be enabled (true), or disabled (false).
 	 *
-	 * @param AbstractTask $ga
 	 * @param bool $status
+	 * @return void
 	 */
 	public function setTaskStatus(AbstractTask $task, $status);
 		
@@ -49,6 +49,7 @@ 
      * Delete the task from the database, in a transactional manner.
      *
      * @param string $task_name Task to delete
+     * @return boolean
      */
     public function deleteTask($task_name);
     
@@ -75,7 +76,7 @@ 
      * Returns the list of tasks that are currently meant to run.
      * Tasks to run can be forced, or can be limited to only one.
      * 
-     * @param string|null $force Force the enabled tasks to run.
+     * @param boolean $force Force the enabled tasks to run.
      * @param string|null $task_name Name of the specific task to run
      */
 	function getTasksToRun($force = false, $task_name = null);

src/Webtrees/Module/Certificates/Model/Certificate.php

Doc Comments +2 added lines, -1 removed lines

@@ -109,6 +109,7 @@ 
 	/**
 	 * {@inhericDoc}
 	 * @see \Fisharebest\Webtrees\GedcomRecord::getInstance()
+	 * @param string $xref
 	 */	
 	static public function getInstance($xref, Tree $tree, $gedcom = null, CertificateProviderInterface $provider = null) {
 		try{
@@ -150,7 +151,7 @@ 
 	/**
 	 * Define a source associated with the certificate
 	 *
-	 * @param string|Source $xref
+	 * @param string|null $xref
 	 */
 	public function setSource($xref){
 		if($xref instanceof Source){

src/Webtrees/Module/CertificatesModule.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
     /**
      * Return the HTML code for custom simple tag _ACT
      *
-     * @param Certificate $certificatePath Certificate (as per the GEDCOM)
+     * @param Certificate $certificate Certificate (as per the GEDCOM)
      * @param string|null $sid Linked Source ID, if it exists
      */
     protected function getDisplay_ACT(Certificate $certificate, $sid = null){    

src/Webtrees/Module/PatronymicLineage/Model/LineageNode.php

Doc Comments +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
 	/**
 	 * Constructor for Lineage node
 	 * 
-	 * @param Fisharebest\Webtrees\Individual $node_indi Main individual
+	 * @param Individual $node_indi Main individual
 	 * @param LineageRootNode $root_node Node of the lineage root
 	 * @param unknown $alt_surname Follow-up surname
 	 */
@@ -54,7 +54,7 @@ 
 	/**
 	 * Add a spouse family to the node
 	 * 
-	 * @param Fisharebest\Webtrees\Family $fams
+	 * @param Family $fams
 	 */
 	public function addFamily(Family $fams) {
 		if($fams && !isset($this->linked_fams[$fams])) {
@@ -65,7 +65,7 @@ 
 	/**
 	 * Add a child LineageNode to the node
 	 * 
-	 * @param Fisharebest\Webtrees\Family $fams
+	 * @param Family $fams
 	 * @param LineageNode $child
 	 */
 	public function addChild(Family $fams, LineageNode $child = null) {
@@ -80,7 +80,7 @@ 
 	/**
 	 * Returns the node individual
 	 * 
-	 * @return Fisharebest\Webtrees\Individual
+	 * @return \Fisharebest\Webtrees\GedcomRecord
 	 */
 	public function getIndividual() {
 		return $this->node_indi;

src/Webtrees/Module/Sosa/Model/SosaProvider.php

Doc Comments +8 added lines, -9 removed lines

@@ -246,7 +246,6 @@ 
     /**
      * Return the list of all sosas, with the generations it belongs to
      *
-     * @param int $ged_id ID of the gedcom file
      * @return array Associative array of Sosa ancestors, with their generation, comma separated
      */
     public function getAllSosaWithGenerations(){
@@ -266,7 +265,7 @@ 
     /**
      * Get an associative array of Sosa individuals in generation G. Keys are Sosa numbers, values individuals.
      *
-     * @param number $gen Generation
+     * @param integer $gen Generation
      * @return array Array of Sosa individuals
      */
     public function getSosaListAtGeneration($gen){
@@ -297,7 +296,7 @@ 
     /**
      * Get an associative array of Sosa families in generation G. Keys are Sosa numbers for the husband, values families.
      *
-     * @param number $gen Generation
+     * @param integer $gen Generation
      * @return array Array of Sosa families
      */
     public function getFamilySosaListAtGeneration($gen){
@@ -333,7 +332,7 @@ 
     /**
      * Get an associative array of Sosa individuals in generation G who are missing parents. Keys are Sosa numbers, values individuals.
      *
-     * @param number $gen Generation
+     * @param integer $gen Generation
      * @return array Array of Sosa individuals
      */
     public function getMissingSosaListAtGeneration($gen){
@@ -428,8 +427,8 @@ 
     /**
      * Get the number of Sosa in a specific generation.
      *
-     * @param number $gen Generation
-     * @return number Number of Sosas in generation
+     * @param integer $gen Generation
+     * @return integer Number of Sosas in generation
      */
     public function getSosaCountAtGeneration($gen){
         if(!$this->is_setup) return 0;
@@ -447,7 +446,7 @@ 
     /**
      * Get the total number of Sosa up to a specific generation.
      *
-     * @param number $gen Generation
+     * @param integer $gen Generation
      * @return number Total number of Sosas up to generation
      */
     public function getSosaCountUpToGeneration($gen){
@@ -482,7 +481,7 @@ 
     /**
      * Get the number of distinct Sosa individual up to a specific generation.
      *
-     * @param number $gen Generation
+     * @param integer $gen Generation
      * @return number Number of distinct Sosa individuals up to generation
      */
     public function getDifferentSosaCountUpToGeneration($gen){
@@ -505,7 +504,7 @@ 
      *  - last : Last birth year in generation
      *  - avg : Average birth year
      *
-     * @param number $gen Generation
+     * @param integer $gen Generation
      * @return array Birth statistics array
      */
     public function getStatsBirthYearInGeneration($gen){