jon48 / webtrees-lib

src/Webtrees/Cache.php

Doc Comments +1 added lines, -1 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);

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/Functions.php

Doc Comments +7 added lines, -7 removed lines

@@ -51,8 +51,8 @@ 
 	 * 
 	 * @param integer $num Numerator
 	 * @param integer $denom Denominator
-	 * @param float $default Default value if denominator null or 0
-	 * @return float Result of the safe division
+	 * @param integer $default Default value if denominator null or 0
+	 * @return integer Result of the safe division
 	 */
 	public static function safeDivision($num, $denom, $default = 0) {
 		if($denom && $denom!=0){
@@ -66,8 +66,8 @@ 
 	 *
 	 * @param int $num Numerator
 	 * @param int $denom Denominator
-	 * @param float $default Default value if denominator null or 0
-	 * @return float Percentage
+	 * @param integer $default Default value if denominator null or 0
+	 * @return integer Percentage
 	 */
 	public static function getPercentage($num, $denom, $default = 0){
 		return 100 * self::safeDivision($num, $denom, $default);
@@ -78,7 +78,7 @@ 
 	 *
 	 * @param string $file The image to resize
 	 * @param int $target	The final max width/height
-	 * @return array array of ($width, $height). One of them must be $target
+	 * @return integer[] array of ($width, $height). One of them must be $target
 	 */
 	static public function getResizedImageSize($file, $target=25){
 		list($width, $height, $type, $attr) = getimagesize($file);
@@ -233,7 +233,7 @@ 
 	 * Returns the generation associated with a Sosa number
 	 *
 	 * @param int $sosa Sosa number
-	 * @return number
+	 * @return integer
 	 */
 	public static function getGeneration($sosa){
 		return(int)log($sosa, 2)+1;
@@ -246,7 +246,7 @@ 
 	 * Returns whether the image type is supported by the system, and if so, return the standardised type
 	 *
 	 * @param string $reqtype Extension to test
-	 * @return boolean|string Is supported?
+	 * @return false|string Is supported?
 	 */
 	public static function isImageTypeSupported($reqtype) {
 	    $supportByGD = array('jpg'=>'jpeg', 'jpeg'=>'jpeg', 'gif'=>'gif', 'png'=>'png');

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/Hook/HookInterfaces/CustomSimpleTagManager.php

Doc Comments +2 added lines

@@ -45,6 +45,7 @@ 
 	 * @param string $element_name Element name from the edit interface, used to POST values for update
 	 * @param string $context Tag context
 	 * @param string $contextid Id of tag context
+	 * @return string
 	 */
 	public function hHtmlSimpleTagEditor($tag, $value = null, $element_id = '', $element_name = '', $context = null, $contextid = null);
 	
@@ -53,6 +54,7 @@ 
 	 * 
 	 * @param string $context Context of the edition
 	 * @param int $level Level to which add the tags
+	 * @return void
 	 */
 	public function hAddSimpleTag($context, $level);
 

src/Webtrees/Hook/HookInterfaces/FactSourceTextExtender.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/RecordNameTextExtender.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/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