jon48 / webtrees-lib

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){

src/Webtrees/Mvc/View/ViewBag.php

Doc Comments -1 removed lines

@@ -42,7 +42,6 @@
      * Get all the data from the bag for a given key.
      *
      * @param  string  $key
-     * @param  string  $format
      * @return unknown
      */
     public function get($key, $default = null)

src/Webtrees/Place.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
 	/**
 	 * Contructor for the decorator
 	 *
-	 * @param \Fisharebest\Webtrees\Place $place_in The Place to extend
+	 * @param \Fisharebest\Webtrees\Place $place The Place to extend
 	 */
 	public function __construct(\Fisharebest\Webtrees\Place $place){
 		$this->_place = $place;

src/Webtrees/Hook/HookInterfaces/CustomSimpleTagManagerInterface.php

Doc Comments +2 added lines

@@ -19,6 +19,7 @@ 
 	 * Insert some content before the fact source text.
 	 * 
 	 * @param string $srec Source fact record
+	 * @return string
 	 */
 	public function hFactSourcePrepend($srec);
 	
@@ -26,6 +27,7 @@ 
 	 * Insert some content after the fact source text.
 	 * 
 	 * @param string $srec Source fact record
+	 * @return void
 	 */
 	public function hFactSourceAppend($srec);
 	

src/Webtrees/Hook/HookInterfaces/FactSourceTextExtenderInterface.php

Doc Comments +2 added lines

@@ -19,6 +19,7 @@ 
 	 * Insert some content before the fact source text.
 	 * 
 	 * @param string $srec Source fact record
+	 * @return string
 	 */
 	public function hFactSourcePrepend($srec);
 	
@@ -26,6 +27,7 @@ 
 	 * Insert some content after the fact source text.
 	 * 
 	 * @param string $srec Source fact record
+	 * @return void
 	 */
 	public function hFactSourceAppend($srec);
 	

src/Webtrees/Hook/HookInterfaces/RecordNameTextExtenderInterface.php

Doc Comments +2 added lines

@@ -21,6 +21,7 @@ 
 	 * Insert some content before the record name text.
 	 * 
 	 * @param GedcomRecord $grec Gedcom record
+	 * @return void
 	 */
 	public function hRecordNamePrepend(GedcomRecord $grec);
 	
@@ -28,6 +29,7 @@ 
 	 * Insert some content after the record name text.
 	 * 
 	 * @param GedcomRecord $grec Gedcom record
+	 * @return string
 	 */
 	public function hRecordNameAppend(GedcomRecord $grec);
 	

src/Webtrees/Cache.php

Doc Comments +2 added lines, -2 removed lines

@@ -114,7 +114,7 @@ 
 	 *
 	 * @param string $value Value name
 	 * @param AbstractModule $mod Calling module
-	 * @return bool True is cached
+	 * @return boolean|null True is cached
 	 */
 	public static function isCached($value, AbstractModule $mod = null) {
 	    self::getInstance()->isCachedI($value, $mod);
@@ -149,7 +149,7 @@ 
 	 * @param string $value Value name
 	 * @param mixed $data Value
 	 * @param AbstractModule $mod Calling module
-	 * @return mixed Cached value
+	 * @return unknown_type|null Cached value
 	 */
 	public function saveI($value, $data, AbstractModule $mod = null){
 		$this->checkInit();