Merge pull request #15224 from frederic34/apiclean

doxygen

htdocs/categories/class/api_categories.class.php

@@ -658,7 +658,7 @@ class Categories extends DolibarrApi
 	 * Clean sensible object datas
 	 *
 	 * @param   Categorie  $object    Object to clean
-	 * @return    array    Array of cleaned object properties
+	 * @return  Object     Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
 	{

htdocs/comm/action/class/api_agendaevents.class.php

@@ -327,8 +327,8 @@ class AgendaEvents extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param	object	$object		Object to clean
-     * @return	array				Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/comm/propal/class/api_proposals.class.php

@@ -846,8 +846,8 @@ class Proposals extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   object  $object    Object to clean
-	 * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
 	{

htdocs/commande/class/api_orders.class.php

@@ -950,8 +950,8 @@ class Orders extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   object  $object    Object to clean
-	 * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
 	{

htdocs/compta/bank/class/api_bankaccounts.class.php

@@ -391,8 +391,8 @@ class BankAccounts extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param object    $object    Object to clean
-     * @return array Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/compta/facture/class/api_invoices.class.php

@@ -1643,8 +1643,8 @@ class Invoices extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/contrat/class/api_contracts.class.php

@@ -633,8 +633,8 @@ class Contracts extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/core/triggers/interface_99_modZapier_ZapierTriggers.class.php

@@ -368,8 +368,8 @@ function zapierPostWebhook($url, $json)
 /**
  * Clean sensible object datas
  *
- * @param   object  $toclean    Object to clean
- * @return  array   Array of cleaned object properties
+ * @param   Object  $toclean    Object to clean
+ * @return  Object              Object with cleaned properties
  */
 function cleanObjectDatas($toclean)
 {
@@ -454,7 +454,7 @@ function cleanObjectDatas($toclean)
  * Clean sensible object datas
  *
  * @param   object  $toclean    Object to clean
- * @return  array   Array of cleaned object properties
+ * @return  Object              Object with cleaned properties
  */
 function cleanAgendaEventsDatas($toclean)
 {

htdocs/don/class/api_donations.class.php

@@ -327,8 +327,8 @@ class Donations extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/expedition/class/api_shipments.class.php

@@ -610,8 +610,8 @@ class Shipments extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/expensereport/class/api_expensereports.class.php

@@ -494,8 +494,8 @@ class ExpenseReports extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/fichinter/class/api_interventions.class.php

@@ -420,8 +420,8 @@ class Interventions extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/fourn/class/api_supplier_invoices.class.php

@@ -677,8 +677,8 @@ class SupplierInvoices extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   Object  $object    Object to clean
-	 * @return  array              Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
 	{

htdocs/fourn/class/api_supplier_orders.class.php

@@ -339,8 +339,8 @@ class SupplierOrders extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   Object  $object    Object to clean
-	 * @return  array              Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
 	{

htdocs/modulebuilder/template/class/api_mymodule.class.php

@@ -290,8 +290,8 @@ class MyModuleApi extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   object  $object    Object to clean
-	 * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
 	{

htdocs/mrp/class/api_mos.class.php

@@ -270,8 +270,8 @@ class Mos extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   object  $object     Object to clean
-	 * @return  array               Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
 	{

htdocs/product/class/api_products.class.php

@@ -1740,8 +1740,8 @@ class Products extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param  object $object Object to clean
-     * @return array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/product/stock/class/api_stockmovements.class.php

@@ -276,8 +276,8 @@ class StockMovements extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   MouvementStock  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   MouvementStock $object     Object to clean
+     * @return  Object                     Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/product/stock/class/api_warehouses.class.php

@@ -255,8 +255,8 @@ class Warehouses extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   Entrepot  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Entrepot  $object   Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/projet/class/api_projects.class.php

@@ -542,8 +542,8 @@ class Projects extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/projet/class/api_tasks.class.php

@@ -550,8 +550,8 @@ class Tasks extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   object  $object    Object to clean
-	 * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
 	{

htdocs/societe/class/api_contacts.class.php

@@ -519,7 +519,7 @@ class Contacts extends DolibarrApi
      * Clean sensible object datas
      *
      * @param   Object  $object     Object to clean
-     * @return  array               Array of cleaned object properties
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/societe/class/api_thirdparties.class.php

@@ -1771,8 +1771,8 @@ class Thirdparties extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   Object  $object    Object to clean
-	 * @return     Object    Object with cleaned properties
+	 * @param   Object  $object     Object to clean
+	 * @return  Object              Object with cleaned properties
 	 */
 	protected function _cleanObjectDatas($object)
     {

htdocs/supplier_proposal/class/api_supplier_proposals.class.php

@@ -193,8 +193,8 @@ class Supplierproposals extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object    Object to clean
-     * @return    array    Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      */
     protected function _cleanObjectDatas($object)
     {

htdocs/ticket/class/api_tickets.class.php

@@ -487,8 +487,8 @@ class Tickets extends DolibarrApi
     /**
      * Clean sensible object datas
      *
-     * @param   object  $object	Object to clean
-     * @return	array	Array of cleaned object properties
+     * @param   Object  $object     Object to clean
+     * @return  Object              Object with cleaned properties
      *
      * @todo use an array for properties to clean
      *

htdocs/zapier/class/api_zapier.class.php

@@ -335,8 +335,8 @@ class ZapierApi extends DolibarrApi
 	/**
 	 * Clean sensible object datas
 	 *
-	 * @param   object  $object    Object to clean
-	 * @return  array    Array of cleaned object properties
+	 * @param   Object  $object     Object to clean
+	 * @return  Object              Object with cleaned properties
 	 */
 	public function _cleanObjectDatas($object)
 	{