[Noalyss-commit] [noalyss] 28/35: Improve Doc : doxygen

[Dany De Bontridder]

sparkyx pushed a commit to branch master
in repository noalyss.

commit ebf12e471163fbba40e0db873c7d2d4fd6475990
Author: Dany De Bontridder <address@hidden>
Date:   Sun May 8 16:30:59 2016 +0200

    Improve Doc : doxygen
---
 include/class/class_periode.php |    8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/include/class/class_periode.php b/include/class/class_periode.php
index 67f43b0..54000f7 100644
--- a/include/class/class_periode.php
+++ b/include/class/class_periode.php
@@ -81,6 +81,8 @@ class Periode
             return 1;
         return 0;
     }
+    ///Return 1 if the periode is open otherwise 0
+    //!\note For only a ledger you must set Periode::jrn_def_id to the ledger 
id
     function is_open()
     {
         /* if jrn_Def_id == 0 then we check the global otherwise we check
@@ -99,6 +101,8 @@ class Periode
             return 1;
         return 0;
     }
+    ///Return 1 if periode is centralized
+    //!\note deprecated , centralization not used anymore
     function is_centralized()
     {
         if ( $this->jrn_def_id != 0 )
@@ -138,7 +142,9 @@ class Periode
         }
 
     }
-
+    ///Close a periode , if Periode::jrn_def_id is set to a different value
+    /// than 0 , it close only for this ledger id ; otherwise close for all 
+    /// periode
     function close()
     {
         if ( $this->jrn_def_id == 0 )