Skip to content

Commit

Permalink
doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@frederic34
frederic34 committed Dec 15, 2019
1 parent a796106 commit 9e4fb8d
Show file tree
Hide file tree
Showing 36 changed files with 147 additions and 264 deletions.
1 change: 0 additions & 1 deletion htdocs/accountancy/class/accountancycategory.class.php
View file
Expand Up @@ -38,7 +38,6 @@ class AccountancyCategory // extends CommonObject

/**
* @var string Error string
* @see $errors
*/
public $error;

Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/class/openid.class.php
View file
Expand Up @@ -158,7 +158,7 @@ public function SetIdentity($a)
}else{
$identity = $u['scheme'] . '://' . $u['host'] . $u['path'];
}
//*/
*/
$this->openid_url_identity = $a;
}

Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/export/export_excel2007new.modules.php
View file
Expand Up @@ -17,7 +17,7 @@
*/

/**
* \file htdocs/core/modules/export/export_excelnew.modules.php
* \file htdocs/core/modules/export/export_excel2007new.modules.php
* \ingroup export
* \brief File of class to generate export file with Excel format
*/
Expand Down
4 changes: 2 additions & 2 deletions htdocs/core/modules/mailings/advthirdparties.modules.php
View file
Expand Up @@ -10,8 +10,8 @@
*/

/**
* \file advtargetingemaling/modules/mailings/advthirdparties.modules.php
* \ingroup advtargetingemaling
* \file htdocs/core/modules/mailings/advthirdparties.modules.php
* \ingroup mailing
* \brief Example file to provide a list of recipients for mailing module
*/

Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modBom.class.php
View file
Expand Up @@ -21,7 +21,7 @@
* \defgroup bom Module Bom
* \brief Bom module descriptor.
*
* \file htdocs/bom/core/modules/modBom.class.php
* \file htdocs/core/modules/modBom.class.php
* \ingroup bom
* \brief Description and activation file for module Bom
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modDataPolicy.class.php
View file
Expand Up @@ -21,7 +21,7 @@
* \defgroup datapolicy Module datapolicy
* \brief datapolicy module descriptor.
*
* \file htdocs/datapolicy/core/modules/modDataPolicy.class.php
* \file htdocs/core/modules/modDataPolicy.class.php
* \ingroup datapolicy
* \brief Description and activation file for module DATAPOLICY
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modEmailCollector.class.php
View file
Expand Up @@ -19,7 +19,7 @@
* \defgroup emailcollector Module emailcollector
* \brief emailcollector module descriptor.
*
* \file htdocs/emailcollector/core/modules/modEmailCollector.class.php
* \file htdocs/core/modules/modEmailCollector.class.php
* \ingroup emailcollector
* \brief Description and activation file for module emailcollector
*/
Expand Down
9 changes: 4 additions & 5 deletions htdocs/core/modules/modIncoterm.class.php
View file
Expand Up @@ -18,11 +18,10 @@
*/

/**
* \defgroup mymodule Module MyModule
* \brief Example of a module descriptor.
* Such a file must be copied into htdocs/mymodule/core/modules directory.
* \file htdocs/mymodule/core/modules/modMyModule.class.php
* \ingroup mymodule
* \defgroup incoterm Module MyModule
*
* \file htdocs/core/modules/modIncoterm.class.php
* \ingroup incoterm
* \brief Description and activation file for module MyModule
*/
include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
Expand Down
4 changes: 2 additions & 2 deletions htdocs/core/modules/modMrp.class.php
View file
Expand Up @@ -19,10 +19,10 @@
*/

/**
* \defgroup mrp Module Mrp
* \defgroup mrp Module Mrp
* \brief Mrp module descriptor.
*
* \file htdocs/mrp/core/modules/modMrp.class.php
* \file htdocs/core/modules/modMrp.class.php
* \ingroup mrp
* \brief Description and activation file for module Mrp
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/modTakePos.class.php
View file
Expand Up @@ -20,7 +20,7 @@
* \defgroup takepos Module TakePos
* \brief TakePos module descriptor.
*
* \file htdocs/takepos/core/modules/modTakePos.class.php
* \file htdocs/core/modules/modTakePos.class.php
* \ingroup takepos
* \brief Description and activation file for module TakePos
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/printing/modules_printing.php
View file
Expand Up @@ -18,7 +18,7 @@
*/

/**
* \file htdocs/core/modules/mailings/modules_printing.php
* \file htdocs/core/modules/printing/modules_printing.php
* \ingroup printing
* \brief File with parent class of printing modules
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/supplier_payment/doc/pdf_standard.modules.php
View file
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file htdocs/core/modules/supplier_invoice/doc/pdf_standard.modules.php
* \file htdocs/core/modules/supplier_payment/doc/pdf_standard.modules.php
* \ingroup fournisseur
* \brief Class file to generate the supplier invoice payment file with the standard model
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/core/modules/supplier_payment/mod_supplier_payment_bronan.php
View file
Expand Up @@ -17,7 +17,7 @@
*/

/**
* \file htdocs/core/modules/payment/mod_payment_bronan.php
* \file htdocs/core/modules/supplier_payment/mod_supplier_payment_bronan.php
* \ingroup supplier_payment
* \brief File containing class for numbering module Bronan
*/
Expand Down
2 changes: 1 addition & 1 deletion htdocs/don/payment/payment.php
View file
Expand Up @@ -17,7 +17,7 @@
*/

/**
* \file htdocs/don/payment.php
* \file htdocs/don/payment/payment.php
* \ingroup donations
* \brief Page to add payment of a donation
*/
Expand Down
4 changes: 2 additions & 2 deletions htdocs/ecm/class/ecmfiles.class.php
View file
Expand Up @@ -4,7 +4,7 @@
* Copyright (C) 2015 Florian Henry <florian.henry@open-concept.pro>
* Copyright (C) 2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
* Copyright (C) 2018 Francis Appels <francis.appels@yahoo.com>
* Copyright (C) ---Put here your own copyright and developer email---
* Copyright (C) 2019 Frédéric France <frederic.france@netlogic.fr>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
Expand All @@ -21,7 +21,7 @@
*/

/**
* \file ecm/ecmfiles.class.php
* \file htdocs/ecm/class/ecmfiles.class.php
* \ingroup ecm
* \brief Class to manage ECM Files (Create/Read/Update/Delete)
*/
Expand Down
116 changes: 58 additions & 58 deletions htdocs/expedition/class/api_shipments.class.php
View file
Expand Up @@ -208,15 +208,15 @@ public function post($request_data = null)
return $this->shipment->id;
}

/**
* Get lines of an shipment
*
* @param int $id Id of shipment
*
* @url GET {id}/lines
*
* @return int
*/
// /**
// * Get lines of an shipment
// *
// * @param int $id Id of shipment
// *
// * @url GET {id}/lines
// *
// * @return int
// */
/*
public function getLines($id)
{
Expand All @@ -241,16 +241,16 @@ public function getLines($id)
}
*/

/**
* Add a line to given shipment
*
* @param int $id Id of shipment to update
* @param array $request_data ShipmentLine data
*
* @url POST {id}/lines
*
* @return int
*/
// /**
// * Add a line to given shipment
// *
// * @param int $id Id of shipment to update
// * @param array $request_data ShipmentLine data
// *
// * @url POST {id}/lines
// *
// * @return int
// */
/*
public function postLine($id, $request_data = null)
{
Expand Down Expand Up @@ -303,17 +303,17 @@ public function postLine($id, $request_data = null)
return false;
}*/

/**
* Update a line to given shipment
*
* @param int $id Id of shipment to update
* @param int $lineid Id of line to update
* @param array $request_data ShipmentLine data
*
* @url PUT {id}/lines/{lineid}
*
* @return object
*/
// /**
// * Update a line to given shipment
// *
// * @param int $id Id of shipment to update
// * @param int $lineid Id of line to update
// * @param array $request_data ShipmentLine data
// *
// * @url PUT {id}/lines/{lineid}
// *
// * @return object
// */
/*
public function putLine($id, $lineid, $request_data = null)
{
Expand Down Expand Up @@ -486,7 +486,7 @@ public function delete($id)
* @url POST {id}/validate
*
* @return array
* FIXME An error 403 is returned if the request has an empty body.
* \todo An error 403 is returned if the request has an empty body.
* Error message: "Forbidden: Content type `text/plain` is not supported."
* Workaround: send this in the body
* {
Expand Down Expand Up @@ -528,20 +528,20 @@ public function validate($id, $notrigger = 0)
}


/**
* Classify the shipment as invoiced
*
* @param int $id Id of the shipment
*
* @url POST {id}/setinvoiced
*
* @return int
*
* @throws 400
* @throws 401
* @throws 404
* @throws 405
*/
// /**
// * Classify the shipment as invoiced
// *
// * @param int $id Id of the shipment
// *
// * @url POST {id}/setinvoiced
// *
// * @return int
// *
// * @throws 400
// * @throws 401
// * @throws 404
// * @throws 405
// */
/*
public function setinvoiced($id)
{
Expand All @@ -566,19 +566,19 @@ public function setinvoiced($id)
*/


/**
* Create a shipment using an existing order.
*
* @param int $orderid Id of the order
*
* @url POST /createfromorder/{orderid}
*
* @return int
* @throws 400
* @throws 401
* @throws 404
* @throws 405
*/
// /**
// * Create a shipment using an existing order.
// *
// * @param int $orderid Id of the order
// *
// * @url POST /createfromorder/{orderid}
// *
// * @return int
// * @throws 400
// * @throws 401
// * @throws 404
// * @throws 405
// */
/*
public function createShipmentFromOrder($orderid)
{
Expand Down
4 changes: 2 additions & 2 deletions htdocs/product/stock/class/productstockentrepot.class.php
View file
Expand Up @@ -3,7 +3,7 @@
* Copyright (C) 2014-2016 Juanjo Menent <jmenent@2byte.es>
* Copyright (C) 2015 Florian Henry <florian.henry@open-concept.pro>
* Copyright (C) 2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
* Copyright (C) 2018 Frédéric France <frederic.france@netlogic.fr>
* Copyright (C) 2018-2019 Frédéric France <frederic.france@netlogic.fr>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
Expand All @@ -20,7 +20,7 @@
*/

/**
* \file ProductEntrepot/ProductStockEntrepot.class.php
* \file htdocs/product/stock/class/productstockentrepot.class.php
* \ingroup ProductEntrepot
* \brief This file is an example for a CRUD class file (Create/Read/Update/Delete)
* Put some comments here
Expand Down

0 comments on commit 9e4fb8d

Please sign in to comment.