lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2020-02-18 22:58:51 +01:00
parent 0212bc5cf2
commit 8c52f324ac
2 changed files with 21 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
htdocs/api/class/api_documents.class.php
View File

@ -60,10 +60,9 @@ class Documents extends DolibarrApi
* @param string $original_file Relative path with filename, relative to modulepart (for example: IN201701-999/IN201701-999.pdf) * @param string $original_file Relative path with filename, relative to modulepart (for example: IN201701-999/IN201701-999.pdf)
* @return array List of documents * @return array List of documents
* *
* @throws 400 * @throws RestException 400
* @throws 401 * @throws RestException 401
* @throws 404 * @throws RestException 404
* @throws 200
* *
* @url GET /download * @url GET /download
*/ */
@ -118,12 +117,11 @@ class Documents extends DolibarrApi
* @param string $langcode Language code like 'en_US', 'fr_FR', 'es_ES', ... (If not set, use the default language). * @param string $langcode Language code like 'en_US', 'fr_FR', 'es_ES', ... (If not set, use the default language).
* @return array List of documents * @return array List of documents
* *
* @throws 500 * @throws RestException 500
* @throws 501 * @throws RestException 501
* @throws 400 * @throws RestException 400
* @throws 401 * @throws RestException 401
* @throws 404 * @throws RestException 404
* @throws 200
* *
* @url PUT /builddoc * @url PUT /builddoc
*/ */
@ -237,11 +235,10 @@ class Documents extends DolibarrApi
* @param string $sortorder Sort order ('asc' or 'desc') * @param string $sortorder Sort order ('asc' or 'desc')
* @return array Array of documents with path * @return array Array of documents with path
* *
* @throws 200 * @throws RestException 400
* @throws 400 * @throws RestException 401
* @throws 401 * @throws RestException 404
* @throws 404 * @throws RestException 500
* @throws 500
* *
* @url GET / * @url GET /
*/ */
@ -447,11 +444,10 @@ class Documents extends DolibarrApi
* @param int $overwriteifexists Overwrite file if exists (1 by default) * @param int $overwriteifexists Overwrite file if exists (1 by default)
* @return string * @return string
* *
* @throws 200 * @throws RestException 400
* @throws 400 * @throws RestException 401
* @throws 401 * @throws RestException 404
* @throws 404 * @throws RestException 500
* @throws 500
* *
* @url POST /upload * @url POST /upload
*/ */
@ -627,10 +623,9 @@ class Documents extends DolibarrApi
* @param string $original_file Relative path with filename, relative to modulepart (for example: PRODUCT-REF-999/IMAGE-999.jpg) * @param string $original_file Relative path with filename, relative to modulepart (for example: PRODUCT-REF-999/IMAGE-999.jpg)
* @return array List of documents * @return array List of documents
* *
* @throws 400 * @throws RestException 400
* @throws 401 * @throws RestException 401
* @throws 404 * @throws RestException 404
* @throws 200
* *
* @url DELETE / * @url DELETE /
*/ */

5
htdocs/api/class/api_login.class.php
View File

@ -48,9 +48,8 @@ class Login
* @param int $reset Reset token (0=get current token, 1=ask a new token and canceled old token. This means access using current existing API token of user will fails: new token will be required for new access) * @param int $reset Reset token (0=get current token, 1=ask a new token and canceled old token. This means access using current existing API token of user will fails: new token will be required for new access)
* @return array Response status and user token * @return array Response status and user token
* *
* @throws 200 * @throws RestException 403
* @throws 403 * @throws RestException 500
* @throws 500
* *
* @url GET / * @url GET /
* @url POST / * @url POST /