[Noalyss-commit] [noalyss] 04/27: Documentation

[Dany De Bontridder]

sparkyx pushed a commit to branch master
in repository noalyss.

commit 59d93877b8aa01c11ab3b3919a60f1ff5e6de861
Author: Dany De Bontridder <address@hidden>
Date:   Sat Sep 13 18:23:47 2014 +0200

    Documentation
---
 include/class_anc_key.php |   12 +++++++++---
 1 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/include/class_anc_key.php b/include/class_anc_key.php
index 0cdfecf..0cd492b 100644
--- a/include/class_anc_key.php
+++ b/include/class_anc_key.php
@@ -31,9 +31,6 @@ class Anc_Key
 {
 
     private $key; /* !  the distribution key */
-    private $a_ledger; /* ! array of ledger where the key is available */
-    private $a_activity; /* ! array of activities of this key */
-    private $a_row; /* ! array of row */
 
     function __construct($p_id=-1)
     {
@@ -246,6 +243,15 @@ class Anc_Key
         }
         $cn->commit();
     }
+    /**
+     * @brief Call the Anc_Operation::display_form_plan with the right amounts.
+     * This function compute the array and amount to pass to the 
Anc_Operation::display_form_plan
+     * and replace the current table of activity with the value computed from 
the key.
+     * 
+     * @global $cn database connection
+     * @param $p_target Table to be replaced
+     * @param $p_amount amount to distribute among activities
+     */
     function fill_table($p_target,$p_amount)
     {
         global $cn;