Doxygen

htdocs/adherents/class/api_members.class.php

@@ -55,10 +55,10 @@ class Members extends DolibarrApi
 	 *
 	 * Return an array with member informations
 	 *
-	 * @param     int     $id ID of member
-	 * @return    array|mixed data without useless information
+	 * @param   int     $id 			ID of member
+	 * @return  Object              	Object with cleaned properties
 	 *
-	 * @throws    RestException
+	 * @throws  RestException
 	 */
 	public function get($id)
 	{

htdocs/adherents/class/api_memberstypes.class.php

@@ -48,10 +48,10 @@ class MembersTypes extends DolibarrApi
 	 *
 	 * Return an array with member type informations
 	 *
-	 * @param     int     $id ID of member type
-	 * @return    array|mixed data without useless information
+	 * @param   int     $id 			ID of member type
+	 * @return  Object              	Object with cleaned properties
 	 *
-	 * @throws    RestException
+	 * @throws  RestException
 	 */
 	public function get($id)
 	{

htdocs/adherents/class/api_subscriptions.class.php

@@ -51,10 +51,10 @@ class Subscriptions extends DolibarrApi
 	 *
 	 * Return an array with subscription informations
 	 *
-	 * @param     int     $id ID of subscription
-	 * @return    Object data without useless information
+	 * @param   int     $id 			ID of subscription
+	 * @return  Object              	Object with cleaned properties
 	 *
-	 * @throws    RestException
+	 * @throws  RestException
 	 */
 	public function get($id)
 	{

htdocs/api/class/api.class.php

@@ -98,8 +98,8 @@ class 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/bom/class/api_boms.class.php

@@ -57,8 +57,8 @@ class Boms extends DolibarrApi
 	 *
 	 * Return an array with bom informations
 	 *
-	 * @param 	int 	$id ID of bom
-	 * @return 	array|mixed data without useless information
+	 * @param 	int 	$id 			ID of bom
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @url	GET {id}
 	 * @throws 	RestException

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

@@ -57,8 +57,8 @@ class AgendaEvents extends DolibarrApi
 	 *
 	 * Return an array with Agenda Events informations
 	 *
-	 * @param       int         $id         ID of Agenda Events
-	 * @return 	    array|mixed             Data without useless information
+	 * @param   int         $id         ID of Agenda Events
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

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

@@ -121,8 +121,8 @@ class BankAccounts extends DolibarrApi
 	/**
 	 * Get account by ID.
 	 *
-	 * @param 	int	$id    						ID of account
-	 * @return  	Object              		Object with cleaned properties
+	 * @param 	int			$id				ID of account
+	 * @return  Object              		Object with cleaned properties
 	 *
 	 * @throws RestException
 	 */

htdocs/contrat/class/api_contracts.class.php

@@ -60,9 +60,8 @@ class Contracts extends DolibarrApi
 	 *
 	 * Return an array with contract informations
 	 *
-	 * @param       int         $id         ID of contract
-	 * @return 	array|mixed data without useless information
-	 *
+	 * @param   int         $id         ID of contract
+	 * @return  Object              	Object with cleaned properties
 	 * @throws 	RestException
 	 */
 	public function get($id)

htdocs/don/class/api_donations.class.php

@@ -56,8 +56,8 @@ class Donations extends DolibarrApi
 	 *
 	 * Return an array with donation informations
 	 *
-	 * @param       int         $id         ID of order
-	 * @return 	array|mixed data without useless information
+	 * @param   int         $id         ID of order
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

htdocs/expedition/class/api_shipments.class.php

@@ -58,8 +58,8 @@ class Shipments extends DolibarrApi
 	 *
 	 * Return an array with shipment informations
 	 *
-	 * @param       int         $id         ID of shipment
-	 * @return 	array|mixed data without useless information
+	 * @param   int         $id         ID of shipment
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

htdocs/expensereport/class/api_expensereports.class.php

@@ -58,8 +58,8 @@ class ExpenseReports extends DolibarrApi
 	 *
 	 * Return an array with Expense Report informations
 	 *
-	 * @param       int         $id         ID of Expense Report
-	 * @return 	    array|mixed             Data without useless information
+	 * @param   int         $id         ID of Expense Report
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

htdocs/fourn/class/api_supplier_invoices.class.php

@@ -58,8 +58,8 @@ class SupplierInvoices extends DolibarrApi
 	 *
 	 * Return an array with supplier invoice information
 	 *
-	 * @param 	int 	$id ID of supplier invoice
-	 * @return 	array|mixed data without useless information
+	 * @param 	int 	$id 			ID of supplier invoice
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

htdocs/knowledgemanagement/class/api_knowledgemanagement.class.php

@@ -60,8 +60,8 @@ class KnowledgeManagement extends DolibarrApi
 	 *
 	 * Return an array with knowledgerecord informations
 	 *
-	 * @param 	int 	$id ID of knowledgerecord
-	 * @return 	array|mixed data without useless information
+	 * @param 	int 	$id 			ID of knowledgerecord
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @url	GET knowledgerecords/{id}
 	 *

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

@@ -61,8 +61,8 @@ class MyModuleApi extends DolibarrApi
 	 *
 	 * Return an array with myobject informations
 	 *
-	 * @param 	int 	$id ID of myobject
-	 * @return 	array|mixed data without useless information
+	 * @param 	int 	$id 			ID of myobject
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @url	GET myobjects/{id}
 	 *

htdocs/mrp/class/api_mos.class.php

@@ -55,8 +55,8 @@ class Mos extends DolibarrApi
 	 *
 	 * Return an array with MO informations
 	 *
-	 * @param 	int 	$id ID of MO
-	 * @return 	array|mixed data without useless information
+	 * @param 	int 	$id 			ID of MO
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @url	GET {id}
 	 * @throws 	RestException

htdocs/multicurrency/class/api_multicurrencies.class.php

@@ -109,7 +109,7 @@ class MultiCurrencies extends DolibarrApi
 	 * Return an array with Currency informations
 	 *
 	 * @param 	int 		$id 	ID of Currency
-	 * @return 	array|mixed 		Data without useless information
+	 * @return  Object              Object with cleaned properties
 	 *
 	 * @throws RestException
 	 */

htdocs/partnership/class/api_partnership.class.php

@@ -59,8 +59,8 @@ class PartnershipApi extends DolibarrApi
 	 *
 	 * Return an array with partnership informations
 	 *
-	 * @param 	int 	$id ID of partnership
-	 * @return 	array|mixed data without useless information
+	 * @param 	int 	$id 			ID of partnership
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @url	GET partnerships/{id}
 	 *

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

@@ -57,8 +57,8 @@ class StockMovements extends DolibarrApi
 	 *
 	 * Return an array with stock movement informations
 	 *
-	 * @param 	int 	$id ID of movement
-	 * @return 	array|mixed data without useless information
+	 * @param 	int 	$id 			ID of movement
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

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

@@ -55,8 +55,8 @@ class Warehouses extends DolibarrApi
 	 *
 	 * Return an array with warehouse informations
 	 *
-	 * @param 	int 	$id ID of warehouse
-	 * @return 	array|mixed data without useless information
+	 * @param 	int 	$id 			ID of warehouse
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

htdocs/projet/class/api_projects.class.php

@@ -58,8 +58,8 @@ class Projects extends DolibarrApi
 	 *
 	 * Return an array with project informations
 	 *
-	 * @param       int         $id         ID of project
-	 * @return 	array|mixed data without useless information
+	 * @param   int         $id         ID of project
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

htdocs/societe/class/api_thirdparties.class.php

@@ -67,8 +67,8 @@ class Thirdparties extends DolibarrApi
 	 *
 	 * Return an array with thirdparty informations
 	 *
-	 * @param 	int 	$id Id of third party to load
-	 * @return 	array|mixed Cleaned Societe object
+	 * @param 	int 	$id 			Id of third party to load
+	 * @return  Object              	Object with cleaned properties
 	 *
 	 * @throws 	RestException
 	 */

htdocs/ticket/class/api_tickets.class.php

@@ -66,7 +66,7 @@ class Tickets extends DolibarrApi
 	 * Return an array with ticket informations
 	 *
 	 * @param	int 			$id 		ID of ticket
-	 * @return 	array|mixed 				Data without useless information
+	 * @return  Object              		Object with cleaned properties
 	 *
 	 * @throws RestException 401
 	 * @throws RestException 403