From 3e5c896b8ffa401dfdf419e28881e102a45f06ec Mon Sep 17 00:00:00 2001
From: Dany De Bontridder <dany@alchimerys.be>
Date: Sat, 3 Jul 2010 20:17:10 +0000
Subject: [PATCH] update doc

---
 include/class_user.php | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/include/class_user.php b/include/class_user.php
index 1e7c17ffa..11eecbb18 100644
--- a/include/class_user.php
+++ b/include/class_user.php
@@ -229,8 +229,17 @@ where use_id=$1 and dos_id=$2";
    * \brief get all the available ledgers for the current user
    * \param $p_type = ALL or the type of the ledger (ACH,VEN,FIN,ODS)
    * \param $p_access =3 for Read or WRITE, 2  write, 1 for readonly
-   *
-   * \return an array
+   *  \return a double array of available ledgers
+   @verbatim
+[0] => [jrn_def_id]
+       [jrn_def_type]
+       [jrn_def_name]
+       [jrn_def_class_deb]
+       [jrn_def_class_cred]
+       [jrn_type_id]
+       [jrn_desc]
+       [uj_priv]
+@endverbatim
    */
   function get_ledger($p_type='ALL',$p_access=3) {
     if ( $this->admin != 1 && $this->is_local_admin() != 1) {