add some phpdoc

This commit is contained in:
Manuel Raynaud
2014-03-17 14:55:26 +01:00
parent 0d6354debc
commit 99eb5c01f4
10 changed files with 74 additions and 10 deletions

View File

@@ -48,9 +48,12 @@ class Order extends BaseOrder
/**
* Compute this order amount.
*
* @param float $tax (output only) returns the tax amount for this order
* @param bool $includePostage if true, the postage cost is included to the total
* @param bool $includeDiscount if true, the discount will be included to the total
* The order amount amount is only avaible once the order is persisted in database.
* Duting invoice process, use all cart methods instead of order methods (the order doest not exists at this moment)
*
* @param float|int $tax (output only) returns the tax amount for this order
* @param bool $includePostage if true, the postage cost is included to the total
* @param bool $includeDiscount if true, the discount will be included to the total
* @return float
*/
public function getTotalAmount(&$tax = 0, $includePostage = true, $includeDiscount = true)