return comment

dev/setup/codesniffer/ruleset.xml

@@ -218,9 +218,9 @@
         <severity>5</severity>
     </rule>
 
-	<rule ref="PEAR.Commenting.FunctionComment.MissingReturn">
+	<!--<rule ref="PEAR.Commenting.FunctionComment.MissingReturn">
         <severity>0</severity>
-    </rule>
+    </rule>-->
     <rule ref="PEAR.Commenting.FunctionComment.Missing">
         <severity>0</severity>
     </rule>

htdocs/adherents/class/adherent.class.php

@@ -2454,6 +2454,7 @@ class Adherent extends CommonObject
 	 * Existing categories are left untouch.
 	 *
 	 * @param int[]|int $categories Category or categories IDs
+     * @return void
 	 */
 	public function setCategories($categories)
 	{

htdocs/admin/dolistore/class/PSWebServiceLibrary.class.php

@@ -82,6 +82,7 @@ class PrestaShopWebservice
 	 * Take the status code and throw an exception if the server didn't return 200 or 201 code
 	 *
 	 * @param int $status_code Status code of an HTTP return
+     * @return void
 	 */
 	protected function checkStatusCode($status_code)
 	{

htdocs/api/class/api.class.php

@@ -217,6 +217,7 @@ class DolibarrApi
 	 * @param string	$feature2		Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
 	 * @param string	$dbt_keyfield   Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
 	 * @param string	$dbt_select     Field name for select if not rowid. Not used if objectid is null (optional)
+     * @return bool
 	 * @throws RestException
 	 */
 	static function _checkAccessToResource($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid') {

htdocs/api/class/api_setup.class.php

@@ -188,6 +188,7 @@ class Setup extends DolibarrApi
      * @param int       $id        ID of country
      * @param string    $lang      Code of the language the name of the
      *                             country must be translated to
+     * @return array 			   Array of cleaned object properties
      *
      * @url     GET dictionary/countries/{id}
      *
@@ -293,6 +294,7 @@ class Setup extends DolibarrApi
      * @param Ccountry $country   Country
      * @param string   $lang      Code of the language the name of the
      *                            country must be translated to
+     * @return void
      */
     private function translateLabel($country, $lang)
     {

htdocs/api/class/api_status.class.php

@@ -28,6 +28,7 @@ class Status
 {
 	/**
      * Get status (Dolibarr version)
+     * @return array
 	 */
 	function index() {
 		global $conf;

htdocs/blockedlog/class/authority.class.php

@@ -106,6 +106,7 @@ class BlockedLogAuthority
 	 *	Add a new block to the chain
 	 *
      *	@param      string		$block		new block to chain
+     *  @return void
 	 */
 	public function addBlock($block) {
 

htdocs/blockedlog/class/blockedlog.class.php

@@ -18,9 +18,6 @@
  * See https://medium.com/@lhartikk/a-blockchain-in-200-lines-of-code-963cc1cc0e54
  */
 
-
-
-
 /*ini_set('unserialize_callback_func', 'mycallback');
 
 function mycallback($classname)
@@ -171,6 +168,7 @@ class BlockedLog
 
 	/**
 	 *  Try to retrieve source object (it it still exists)
+     * @return string
 	 */
 	public function getObjectLink()
 	{
@@ -286,6 +284,7 @@ class BlockedLog
 
 	/**
 	 *      try to retrieve user author
+     * @return string
 	 */
 	public function getUser()
 	{
@@ -1029,6 +1028,7 @@ class BlockedLog
 	 * Check if module was already used or not for at least one recording.
 	 *
 	 * @param	int		$ignoresystem		Ignore system events for the test
+     * @return bool
 	 */
 	function alreadyUsed($ignoresystem=0)
 	{
@@ -1055,4 +1055,3 @@ class BlockedLog
 	}
 
 }
-

htdocs/contact/class/contact.class.php

@@ -1334,6 +1334,7 @@ class Contact extends CommonObject
 	 * Existing categories are left untouch.
 	 *
 	 * @param int[]|int $categories Category or categories IDs
+     * @return void
 	 */
 	public function setCategories($categories)
 	{

htdocs/core/class/commonobject.class.php

@@ -6810,6 +6810,7 @@ abstract class CommonObject
 	 * Function to load data from a SQL pointer into properties of current object $this
 	 *
 	 * @param   stdClass    $obj    Contain data of object from database
+     * @return void
 	 */
 	protected function setVarsFromFetchObj(&$obj)
 	{

htdocs/core/lib/functions.lib.php

@@ -1594,6 +1594,7 @@ function dol_banner_tab($object, $paramid, $morehtml='', $shownav=1, $fieldid='r
  * @param	string	$langkey		Translation key
  * @param 	string	$fieldkey		Key of the html select field the text refers to
  * @param	int		$fieldrequired	1=Field is mandatory
+ * @return string
  * @deprecated Form::editfieldkey
  */
 function fieldLabel($langkey, $fieldkey, $fieldrequired=0)
@@ -7431,6 +7432,7 @@ function getAdvancedPreviewUrl($modulepart, $relativepath, $alldata=0, $param=''
  *
  * @param string	$htmlname	Id of html object
  * @param string	$addlink	Add a 'link to' after
+ * @return string
  */
 function ajax_autoselect($htmlname, $addlink='')
 {
@@ -7568,6 +7570,7 @@ function dol_mimetype($file, $default='application/octet-stream', $mode=0)
  * @param int		$id				id of line
  * @param bool		$checkentity	add filter on entity
  * @param string	$rowidfield		name of the column rowid
+ * @return string
  */
 function getDictvalue($tablename, $field, $id, $checkentity=false, $rowidfield='rowid')
 {

htdocs/core/lib/functionsnumtoword.lib.php

@@ -233,6 +233,7 @@ function dolNumberToWord($numero, $langs, $numorcurrency='number')
  * @param integer $hundreds     Hundreds
  * @param integer $tens         Tens
  * @param integer $units        Units
+ * @return string
  */
 function hundreds2text($hundreds, $tens, $units)
 {

htdocs/core/lib/pdf.lib.php

@@ -263,6 +263,7 @@ function pdf_getHeightForLogo($logo, $url = false)
  *
  * @param TCPDF     $pdf            PDF initialized object
  * @param string    $htmlcontent    HTML Contect
+ * @return number
  * @see getStringHeight
  */
 function pdfGetHeightForHtmlContent(&$pdf, $htmlcontent)
@@ -2120,4 +2121,3 @@ function pdf_getSizeForImage($realpath)
 	}
 	return array('width'=>$width,'height'=>$height);
 }
-

htdocs/core/modules/printsheet/doc/pdf_tcpdflabel.class.php

@@ -77,6 +77,7 @@ class pdf_tcpdflabel extends CommonStickerGenerator
 	 * @param int	  $y		   y position in user units
 	 * @param int	  $w		   width in user units
 	 * @param int	  $h		   height in user units
+     * @return void
 	 */
 	private function writeBarcode(&$pdf, $code, $encoding, $is2d, $x, $y, $w, $h)
 	{

htdocs/expensereport/class/expensereport.class.php

@@ -1297,6 +1297,7 @@ class ExpenseReport extends CommonObject
      * @param User      $fuser      User
      * @param Details   $details    Details
 	 * @param int       $notrigger  Disable triggers
+     * @return int
      */
     function setDeny($fuser,$details,$notrigger=0)
     {

htdocs/modulebuilder/template/test/phpunit/MyModuleFunctionalTest.php

@@ -99,6 +99,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 
 	/**
 	 * Global test setup
+     * @return void
 	 */
 	public static function setUpBeforeClass()
 	{
@@ -106,6 +107,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 
 	/**
 	 * Unit test setup
+     * @return void
 	 */
 	public function setUp()
 	{
@@ -115,6 +117,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 
 	/**
 	 * Verify pre conditions
+     * @return void
 	 */
 	protected function assertPreConditions()
 	{
@@ -122,6 +125,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 
 	/**
 	 * Handle Dolibarr authentication
+     * @return void
 	 */
 	private function authenticate()
 	{
@@ -142,6 +146,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 
 	/**
 	 * Test enabling developer mode
+     * @return bool
 	 */
 	public function testEnableDeveloperMode()
 	{
@@ -161,6 +166,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 	 * Test enabling the module
 	 *
 	 * @depends testEnableDeveloperMode
+     * @return bool
 	 */
 	public function testModuleEnabled()
 	{
@@ -186,6 +192,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 	 * Test access to the configuration page
 	 *
 	 * @depends testModuleEnabled
+     * @return bool
 	 */
 	public function testConfigurationPage()
 	{
@@ -198,6 +205,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 	 * Test access to the about page
 	 *
 	 * @depends testConfigurationPage
+     * @return bool
 	 */
 	public function testAboutPage()
 	{
@@ -210,6 +218,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 	 * Test about page is rendering Markdown
 	 *
 	 * @depends testAboutPage
+     * @return bool
 	 */
 	public function testAboutPageRendersMarkdownReadme()
 	{
@@ -226,6 +235,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 	 * Test box is properly declared
 	 *
 	 * @depends testModuleEnabled
+     * @return bool
 	 */
 	public function testBoxDeclared()
 	{
@@ -238,6 +248,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 	 * Test trigger is properly enabled
 	 *
 	 * @depends testModuleEnabled
+     * @return bool
 	 */
 	public function testTriggerDeclared()
 	{
@@ -254,6 +265,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 	 * Test trigger is properly declared
 	 *
 	 * @depends testTriggerDeclared
+     * @return bool
 	 */
 	public function testTriggerEnabled()
 	{
@@ -268,6 +280,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 
 	/**
 	 * Verify post conditions
+     * @return void
 	 */
 	protected function assertPostConditions()
 	{
@@ -275,6 +288,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 
 	/**
 	 * Unit test teardown
+     * @return void
 	 */
 	public function tearDown()
 	{
@@ -282,6 +296,7 @@ class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
 
 	/**
 	 * Global test teardown
+     * @return void
 	 */
 	public static function tearDownAfterClass()
 	{

htdocs/modulebuilder/template/test/phpunit/MyObjectTest.php

@@ -32,6 +32,7 @@ class MyObjectTest extends \PHPUnit_Framework_TestCase
 {
 	/**
 	 * Global test setup
+     * @return void
 	 */
 	public static function setUpBeforeClass()
 	{
@@ -40,6 +41,7 @@ class MyObjectTest extends \PHPUnit_Framework_TestCase
 
 	/**
 	 * Unit test setup
+     * @return void
 	 */
 	protected function setUp()
 	{
@@ -48,6 +50,7 @@ class MyObjectTest extends \PHPUnit_Framework_TestCase
 
 	/**
 	 * Verify pre conditions
+     * @return void
 	 */
 	protected function assertPreConditions()
 	{
@@ -56,6 +59,7 @@ class MyObjectTest extends \PHPUnit_Framework_TestCase
 
 	/**
 	 * A sample test
+     * @return bool
 	 */
 	public function testSomething()
 	{
@@ -66,6 +70,7 @@ class MyObjectTest extends \PHPUnit_Framework_TestCase
 
 	/**
 	 * Verify post conditions
+     * @return void
 	 */
 	protected function assertPostConditions()
 	{
@@ -74,6 +79,7 @@ class MyObjectTest extends \PHPUnit_Framework_TestCase
 
 	/**
 	 * Unit test teardown
+     * @return void
 	 */
 	protected function tearDown()
 	{
@@ -82,6 +88,7 @@ class MyObjectTest extends \PHPUnit_Framework_TestCase
 
 	/**
 	 * Global test teardown
+     * @return void
 	 */
 	public static function tearDownAfterClass()
 	{
@@ -92,6 +99,7 @@ class MyObjectTest extends \PHPUnit_Framework_TestCase
 	 * Unsuccessful test
 	 *
 	 * @param  Exception $e    Exception
+     * @return void
 	 * @throws Exception
 	 */
 	protected function onNotSuccessfulTest(Exception $e)

htdocs/multicurrency/class/multicurrency.class.php

@@ -570,6 +570,7 @@ class MultiCurrency extends CommonObject
 	 *
 	 *  @param	int 	$fk_facture 	id of facture
 	 *  @param 	string 	$table 			facture or facture_fourn
+     *  @return bool
 	 */
 	public static function getInvoiceRate($fk_facture, $table='facture')
 	{
@@ -621,6 +622,7 @@ class MultiCurrency extends CommonObject
 	 *  Sync rates from api
 	 *
 	 *  @param 	array 	$response 	array of reponse from api to sync dolibarr rates
+     * @return void
 	 */
 	public static function syncRates($response)
 	{

htdocs/product/class/product.class.php

@@ -4504,6 +4504,7 @@ class Product extends CommonObject
 	 * Existing categories are left untouch.
 	 *
 	 * @param int[]|int $categories Category or categories IDs
+     * @return void
 	 */
 	public function setCategories($categories) {
 		// Handle single category

htdocs/projet/class/project.class.php

@@ -1904,6 +1904,7 @@ class Project extends CommonObject
 	 * Existing categories are left untouch.
 	 *
 	 * @param int[]|int $categories Category or categories IDs
+     * @return void
 	 */
 	public function setCategories($categories)
 	{
@@ -1972,4 +1973,3 @@ class Project extends CommonObject
 	}
 
 }
-

htdocs/stripe/class/actions_stripe.class.php

@@ -63,6 +63,7 @@ class ActionsStripeconnect
 	 * @param	array	$parameters		Parameters
 	 * @param	Object	$object			Object
 	 * @param	string	$action			Action
+     * @return bool
 	 */
 	function formObjectOptions($parameters, &$object, &$action)
 	{

htdocs/user/class/user.class.php

@@ -910,6 +910,7 @@ class User extends CommonObject
 	 * Existing categories are left untouch.
 	 *
 	 * @param int[]|int $categories Category or categories IDs
+     * @return void
 	 */
 	public function setCategories($categories)
 	{
@@ -3147,4 +3148,3 @@ class User extends CommonObject
 	}
 
 }
-

test/phpunit/RestAPIDocumentTest.php

@@ -94,6 +94,7 @@ class RestAPIDocumentTest extends PHPUnit_Framework_TestCase
 
     /**
      * Init phpunit tests.
+     * @return void
      */
     protected function setUp()
     {
@@ -125,6 +126,7 @@ class RestAPIDocumentTest extends PHPUnit_Framework_TestCase
 
     /**
      * End phpunit tests.
+     * @return void
      */
     protected function tearDown()
     {