lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2011-07-04 09:01:37 +00:00
parent 72d6a714f5
commit 8ca0718d5e
9 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
htdocs/compta/bank/class/account.class.php
View File

@ -24,7 +24,7 @@
* \file htdocs/compta/bank/class/account.class.php
* \ingroup banque
* \brief File of class to manage bank accounts
* \version $Id$
* \version $Id: account.class.php,v 1.31 2011/07/04 09:01:38 eldy Exp $
*/
require_once(DOL_DOCUMENT_ROOT ."/core/class/commonobject.class.php");
@ -1040,7 +1040,7 @@ class AccountLine extends CommonObject
/**
* Load into memory content of a bank transaction line
* @param id Id of bank transaction to load
* @param rowid Id of bank transaction to load
* @param ref Ref of bank transaction to load
* @param num External num to load (ex: num of transaction for paypal fee)
* @return int <0 if KO, >0 if OK
@ -1159,7 +1159,7 @@ class AccountLine extends CommonObject
* Update bank account record in database
* @param user Object user making update
* @param notrigger 0=Disable all triggers
* @param int <0 if KO, >0 if OK
* @return int <0 if KO, >0 if OK
*/
function update($user,$notrigger=0)
{
@ -1192,7 +1192,7 @@ class AccountLine extends CommonObject
* Update conciliation field
* @param user Objet user making update
* @param cat Category id
* @param int <0 if KO, >0 if OK
* @return int <0 if KO, >0 if OK
*/
function update_conciliation($user,$cat)
{
@ -1237,8 +1237,8 @@ class AccountLine extends CommonObject
}
/**
* Charge les informations d'ordre info dans l'objet facture
* @param id Id de la facture a charger
* Charge les informations d'ordre info dans l'objet
* @param rowid Id of object
*/
function info($rowid)
{

16
htdocs/compta/tva/quadri.php
View File

@ -24,7 +24,7 @@
\file htdocs/compta/tva/quadri.php
\ingroup tax
\brief Trimestrial page
\version $Id$
\version $Id: quadri.php,v 1.14 2011/07/04 09:01:38 eldy Exp $
\todo Deal with recurrent invoices as well
*/
@ -49,13 +49,12 @@ $result = restrictedArea($user, 'tax', '', '', 'charges');
/**
* Gets VAT to collect for the given month of the given year
*
* The function gets the VAT in split results, as the VAT declaration asks
* to report the amounts for different VAT rates as different lines.
* This function also accounts recurrent invoices
* @param object Database handler object
* @param integer Year
* @param integer Year quarter (1-4)
* @param db Database handler
* @param y Year
* @param q Year quarter (1-4)
*/
function tva_coll($db,$y,$q)
{
@ -116,12 +115,11 @@ function tva_coll($db,$y,$q)
/**
* Gets VAT to pay for the given month of the given year
*
* The function gets the VAT in split results, as the VAT declaration asks
* to report the amounts for different VAT rates as different lines.
* @param object Database handler object
* @param integer Year
* @param integer Year quarter (1-4)
* @param y Year
* @param q Year quarter (1-4)
*/
function tva_paye($db, $y,$q)
{
@ -317,5 +315,5 @@ echo '</table>';
$db->close();
llxFooter('$Date$ - $Revision$');
llxFooter('$Date: 2011/07/04 09:01:38 $ - $Revision: 1.14 $');
?>

6
htdocs/lib/prelevement.lib.php
View File

@ -23,7 +23,7 @@
* \file htdocs/lib/prelevement.lib.php
* \brief Ensemble de fonctions de base pour le module prelevement
* \ingroup propal
* \version $Id$
* \version $Id: prelevement.lib.php,v 1.8 2011/07/04 09:01:38 eldy Exp $
*
* Ensemble de fonctions de base de dolibarr sous forme d'include
*/
@ -31,8 +31,8 @@
/**
* Prepare head for prelevement screen and return it
* @param prelevement class BonPrelevement
* @return array head
* @param object Object BonPrelevement
* @return array head
*/
function prelevement_prepare_head($object)
{

8
htdocs/lib/product.lib.php
View File

@ -23,7 +23,7 @@
* \file htdocs/lib/product.lib.php
* \brief Ensemble de fonctions de base pour le module produit et service
* \ingroup product
* \version $Id$
* \version $Id: product.lib.php,v 1.43 2011/07/04 09:01:38 eldy Exp $
*
* Ensemble de fonctions de base de dolibarr sous forme d'include
*/
@ -262,9 +262,9 @@ function show_stats_for_company($product,$socid)
/**
* Return translation label of a unit key
* @param int Unit key (-3,0,3,98,99...)
* @param measuring_style Style of unit: weight, volume,...
* @return string Unit string
* @param unit Unit key (-3,0,3,98,99...)
* @param measuring_style Style of unit: weight, volume,...
* @return string Unit string
* @see load_measuring_units
*/
function measuring_units_string($unit,$measuring_style='')

10
htdocs/lib/project.lib.php
View File

@ -22,7 +22,7 @@
* \file htdocs/lib/project.lib.php
* \brief Functions used by project module
* \ingroup project
* \version $Id$
* \version $Id: project.lib.php,v 1.68 2011/07/04 09:01:38 eldy Exp $
*/
require_once(DOL_DOCUMENT_ROOT."/projet/class/project.class.php");
@ -98,7 +98,7 @@ function project_prepare_head($object)
* \file htdocs/lib/project.lib.php
* \brief Ensemble de fonctions de base pour le module projet
* \ingroup societe
* \version $Id$
* \version $Id: project.lib.php,v 1.68 2011/07/04 09:01:38 eldy Exp $
*/
function task_prepare_head($object)
{
@ -239,14 +239,14 @@ function select_projects($socid=-1, $selected='', $htmlname='projectid')
/**
* Enter description here...
*
* Output a task line
* @param $inc
* @param $parent
* @param $lines
* @param $level
* @param $projectsrole
* @param $mytask 0 or 1 to enable only if task is a task i am affected to
* @param $tasksrole
* @param $mytask 0 or 1 to enable only if task is a task i am affected to
* @return $inc
*/
function PLinesb(&$inc, $parent, $lines, &$level, &$projectsrole, &$tasksrole, $mytask=0)

4
htdocs/lib/security.lib.php
View File

@ -21,7 +21,7 @@
/**
* \file htdocs/lib/security.lib.php
* \brief Set of function used for dolibarr security
* \version $Id$
* \version $Id: security.lib.php,v 1.123 2011/07/04 09:01:38 eldy Exp $
*/
@ -398,7 +398,7 @@ function encodedecode_dbpassconf($level=0)
/**
* Encode a string
* @param chaine chaine de caracteres a encoder
* @param chain chaine de caracteres a encoder
* @return string_coded chaine de caracteres encodee
*/
function dol_encode($chain)

19
htdocs/lib/tax.lib.php
View File

@ -21,19 +21,20 @@
* \file htdocs/lib/tax.lib.php
* \ingroup tax
* \brief Library for tax module
* \version $Id$
* \version $Id: tax.lib.php,v 1.20 2011/07/04 09:01:37 eldy Exp $
*/
/**
* \brief Look for collectable VAT clients in the chosen year (and month)
* \param db Database handle
* \param y Year
* \param date_start Start date
* \param date_end End date
* \param modetax 0 or 1 (option vat on debit)
* \param direction 'sell' or 'buy'
* \return array List of customers third parties with vat, -1 if no accountancy module, -2 if not yet developped, -3 if error
* Look for collectable VAT clients in the chosen year (and month)
* @param db Database handle
* @param y Year
* @param date_start Start date
* @param date_end End date
* @param modetax 0 or 1 (option vat on debit)
* @param direction 'sell' or 'buy'
* @param m Month
* @return array List of customers third parties with vat, -1 if no accountancy module, -2 if not yet developped, -3 if error
*/
function vat_by_thirdparty($db, $y, $date_start, $date_end, $modetax, $direction, $m=0)
{

4
htdocs/lib/treeview.lib.php
View File

@ -21,7 +21,7 @@
* \file htdocs/lib/treeview.lib.php
* \ingroup core
* \brief Libraries for tree views
* \version $Id$
* \version $Id: treeview.lib.php,v 1.12 2011/07/04 09:01:38 eldy Exp $
*/
@ -75,9 +75,9 @@ function is_in_subtree($fulltree,$parentid,$childid)
/**
* Show picto of a tree view
*
* @param fulltree Array of entries in correct order
* @param key Key of value to show picto
* @param selected Selected value
* @return array (0 or 1 if at least one of this level after, 0 or 1 if at least one of higher level after)
*/
function tree_showpad(&$fulltree,$key,$selected=0)

7
htdocs/lib/usergroups.lib.php
View File

@ -22,7 +22,7 @@
/**
* \file htdocs/lib/usergroups.lib.php
* \brief Ensemble de fonctions de base pour la gestion des utilisaterus et groupes
* \version $Id$
* \version $Id: usergroups.lib.php,v 1.28 2011/07/04 09:01:38 eldy Exp $
*/
function user_prepare_head($object)
{
@ -144,8 +144,9 @@ function group_prepare_head($object)
/**
* Show list of themes. Show all thumbs of themes
* @param fuser User concerned or '' for global theme
* @param edit 1 to add edit form
* @param fuser User concerned or '' for global theme
* @param edit 1 to add edit form
* @param foruserprofile Show for user profile view
*/
function show_theme($fuser,$edit=0,$foruserprofile=false)
{