REST API: Add comments in the @deprecated tags.

2016-06-22 10:43:35 +02:00 · 2016-06-22 10:43:35 +02:00 · e12e1980fc
commit e12e1980fc
parent 70ba8ec78d
7 changed files with 7 additions and 7 deletions
--- a/htdocs/categories/class/api_deprecated_category.class.php
+++ b/htdocs/categories/class/api_deprecated_category.class.php
@ -27,7 +27,7 @@
 * @access protected 
 * @class  DolibarrApiAccess {@requires user,external}
 * 
- * @deprecated
+ * @deprecated Use Categories instead (defined in api_categories.class.php)
 */
 class CategoryApi extends DolibarrApi
 {
--- a/htdocs/commande/class/api_deprecated_commande.class.php
+++ b/htdocs/commande/class/api_deprecated_commande.class.php
@ -29,7 +29,7 @@
 * @category Api
 * @package  Api
 * 
- * @deprecated
+ * @deprecated Use Orders instead (defined in api_orders.class.php)
 */
 class CommandeApi extends DolibarrApi
 {
--- a/htdocs/compta/facture/class/api_deprecated_invoice.class.php
+++ b/htdocs/compta/facture/class/api_deprecated_invoice.class.php
@ -25,7 +25,7 @@
 * @smart-auto-routing false
 * @access protected 
 * @class  DolibarrApiAccess {@requires user,external}
- * @deprecated
+ * @deprecated Use Invoices instead (defined in api_invoices.class.php)
 */
 class InvoiceApi extends DolibarrApi
 {
--- a/htdocs/product/class/api_deprecated_product.class.php
+++ b/htdocs/product/class/api_deprecated_product.class.php
@ -26,7 +26,7 @@
 * @smart-auto-routing false
 * @access protected 
 * @class  DolibarrApiAccess {@requires user,external}
- * @deprecated
+ * @deprecated Use Products instead (defined in api_products.class.php)
 */
 class ProductApi extends DolibarrApi
 {
--- a/htdocs/societe/class/api_deprecated_contact.class.php
+++ b/htdocs/societe/class/api_deprecated_contact.class.php
@ -25,7 +25,7 @@ use Luracast\Restler\RestException;
 * @smart-auto-routing false
 * @access protected 
 * @class  DolibarrApiAccess {@requires user,external}
- * @deprecated
+ * @deprecated Use Contacts instead (defined in api_contacts.class.php)
 */
 class ContactApi extends DolibarrApi
 {
--- a/htdocs/societe/class/api_deprecated_thirdparty.class.php
+++ b/htdocs/societe/class/api_deprecated_thirdparty.class.php
@ -24,7 +24,7 @@
 * @smart-auto-routing false
 * @access protected 
 * @class  DolibarrApiAccess {@requires user,external}
- * @deprecated
+ * @deprecated Use Thirdparties instead (defined in api_thirdparties.class.php)
 */
 class ThirdpartyApi extends DolibarrApi
 {
--- a/htdocs/user/class/api_deprecated_user.class.php
+++ b/htdocs/user/class/api_deprecated_user.class.php
@ -25,7 +25,7 @@ use Luracast\Restler\RestException;
 * @smart-auto-routing false
 * @access protected 
 * @class  DolibarrApiAccess {@requires user,external}
- * @deprecated
+ * @deprecated Use Users instead (defined in api_users.class.php)
 */
 class UserApi extends DolibarrApi
 {