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-05-25 13:27:07 +00:00
parent c7dfa3d8fc
commit a96c13b8ad
7 changed files with 74 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
htdocs/core/class/translate.class.php
View File

@ -141,7 +141,7 @@ class Translate {
* If data for file already loaded, do nothing. * If data for file already loaded, do nothing.
* All data in translation array are stored in UTF-8 format. * All data in translation array are stored in UTF-8 format.
* tab_loaded is completed with $domain key. * tab_loaded is completed with $domain key.
* Value for hash are: 1:Loaded from disk, 2:Not found, 3:Loaded from cache * Value for hash are: 1:Loaded from disk, 2:Not found, 3:Loaded from cache
* @param domain File name to load (.lang file). Use file@module if file is in a module directory. * @param domain File name to load (.lang file). Use file@module if file is in a module directory.
* @param alt 0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US or fr_FR or es_ES) * @param alt 0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US or fr_FR or es_ES)
* @param stopafterdirection Stop when the DIRECTION tag is found (optimize) * @param stopafterdirection Stop when the DIRECTION tag is found (optimize)

2
htdocs/lib/agenda.lib.php
View File

@ -28,7 +28,7 @@
/** /**
* Show filter form in agenda view * Show filter form in agenda view
* * @param $form
* @param $canedit * @param $canedit
* @param $status * @param $status
* @param $year * @param $year

9
htdocs/lib/ajax.lib.php
View File

@ -27,6 +27,7 @@
/** /**
* Get value of an HTML field, do Ajax process and show result * Get value of an HTML field, do Ajax process and show result
* @param selected Preselecte value
* @param htmlname HTML name of input field * @param htmlname HTML name of input field
* @param url Url for request: /chemin/fichier.php * @param url Url for request: /chemin/fichier.php
* @param option More parameters on URL request * @param option More parameters on URL request
@ -253,9 +254,9 @@ function ajax_constantonoff($code)
} }
/** /**
* * Convert a PHP array into a js array
* Enter description here ... * @param $var
* @param unknown_type $var * @return String with js array or false if error
*/ */
function php2js($var) function php2js($var)
{ {
@ -277,7 +278,7 @@ function php2js($var)
return "\"" . addslashes(stripslashes($var)) . "\""; return "\"" . addslashes(stripslashes($var)) . "\"";
} }
// autres cas: objets, on ne les gère pas // autres cas: objets, on ne les gère pas
return FALSE; return false;
} }

22
htdocs/lib/company.lib.php
View File

@ -330,11 +330,11 @@ function getFormeJuridiqueLabel($code)
/** /**
* \brief Show html area for list of projects * Show html area for list of projects
* \param conf Object conf * @param conf Object conf
* \param lang Object lang * @param lang Object lang
* \param db Database handler * @param db Database handler
* \param objsoc Third party object * @param object Third party object
*/ */
function show_projects($conf,$langs,$db,$object) function show_projects($conf,$langs,$db,$object)
{ {
@ -419,11 +419,11 @@ function show_projects($conf,$langs,$db,$object)
/** /**
* \brief Show html area for list of contacts * Show html area for list of contacts
* \param conf Object conf * @param conf Object conf
* \param lang Object lang * @param lang Object lang
* \param db Database handler * @param db Database handler
* \param objsoc Third party object * @param object Third party object
*/ */
function show_contacts($conf,$langs,$db,$object) function show_contacts($conf,$langs,$db,$object)
{ {
@ -881,7 +881,7 @@ function show_actions_done($conf,$langs,$db,$object,$objcon='',$noprint=0)
* @param conf Object conf * @param conf Object conf
* @param lang Object lang * @param lang Object lang
* @param db Database handler * @param db Database handler
* @param objsoc Third party object * @param object Third party object
*/ */
function show_subsidiaries($conf,$langs,$db,$object) function show_subsidiaries($conf,$langs,$db,$object)
{ {

15
htdocs/lib/date.lib.php
View File

@ -1,5 +1,5 @@
<?php <?php
/* Copyright (C) 2004-2010 Laurent Destailleur <eldy@users.sourceforge.net> /* Copyright (C) 2004-2011 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2005-2008 Regis Houssin <regis@dolibarr.fr> * Copyright (C) 2005-2008 Regis Houssin <regis@dolibarr.fr>
* Copyright (C) 2011 Juanjo Menent <jmenent@2byte.es> * Copyright (C) 2011 Juanjo Menent <jmenent@2byte.es>
* *
@ -200,9 +200,10 @@ function dol_get_next_month($month, $year)
} }
/** Return previous week /** Return previous week
* @param day Day
* @param week Week * @param week Week
* @param year Year * @param year Year
* @return array Previous year,month,week * @return array Previous year,month,day
*/ */
function dol_get_prev_week($day, $week, $month, $year) function dol_get_prev_week($day, $week, $month, $year)
{ {
@ -215,11 +216,12 @@ function dol_get_prev_week($day, $week, $month, $year)
} }
/** Return next week /** Return next week
* @param week Week * @param day Day
* @param week Week
* @param year Year * @param year Year
* @return array Next year,month,week * @return array Next year,month,day
*/ */
function dol_get_next_week($day,$week, $month, $year) function dol_get_next_week($day, $week, $month, $year)
{ {
$tmparray = dol_get_first_day_week($day, $month, $year); $tmparray = dol_get_first_day_week($day, $month, $year);
@ -342,9 +344,10 @@ function dol_get_first_day_week($day,$month,$year,$gm=false)
/** /**
* Fonction retournant le nombre de jour fieries samedis et dimanches entre 2 dates entrees en timestamp * Fonction retournant le nombre de jour fieries samedis et dimanches entre 2 dates entrees en timestamp
* @remarks Called by function num_open_day * Called by function num_open_day
* @param timestampStart Timestamp de debut * @param timestampStart Timestamp de debut
* @param timestampEnd Timestamp de fin * @param timestampEnd Timestamp de fin
* @param countrycode Country code
* @return nbFerie Nombre de jours feries * @return nbFerie Nombre de jours feries
*/ */
function num_public_holiday($timestampStart, $timestampEnd, $countrycode='FR') function num_public_holiday($timestampStart, $timestampEnd, $countrycode='FR')

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

@ -554,7 +554,7 @@ function dol_move_uploaded_file($src_file, $dest_file, $allowoverwrite, $disable
* Remove a file or several files with a mask * Remove a file or several files with a mask
* @param file File to delete or mask of file to delete * @param file File to delete or mask of file to delete
* @param disableglob Disable usage of glob like * * @param disableglob Disable usage of glob like *
* @param boolean True if file is deleted, False if error * @return boolean True if file is deleted, False if error
*/ */
function dol_delete_file($file,$disableglob=0) function dol_delete_file($file,$disableglob=0)
{ {
@ -582,7 +582,7 @@ function dol_delete_file($file,$disableglob=0)
/** /**
* Remove a directory (not recursive, so content must be empty). * Remove a directory (not recursive, so content must be empty).
* If directory is not empty, return false * If directory is not empty, return false
* @param file Directory to delete * @param dir Directory to delete
* @return boolean True if success, false if error * @return boolean True if success, false if error
*/ */
function dol_delete_dir($dir) function dol_delete_dir($dir)
@ -593,7 +593,7 @@ function dol_delete_dir($dir)
/** /**
* Remove a directory $dir and its subdirectories * Remove a directory $dir and its subdirectories
* @param file Dir to delete * @param dir Dir to delete
* @param count Counter to count nb of deleted elements * @param count Counter to count nb of deleted elements
* @return int Number of files and directory removed * @return int Number of files and directory removed
*/ */

32
htdocs/lib/functions.lib.php
View File

@ -550,6 +550,7 @@ function dolibarr_print_date($time,$format='',$to_gmt=false,$outputlangs='',$enc
* false or 'tzserver'=output string is for local PHP server TZ usage * false or 'tzserver'=output string is for local PHP server TZ usage
* 'tzuser'=output string is for local browser TZ usage * 'tzuser'=output string is for local browser TZ usage
* @param outputlangs Object lang that contains language for text translation. * @param outputlangs Object lang that contains language for text translation.
* @param encodetooutput false=no convert into output pagecode
* @return string Formated date or '' if time is null * @return string Formated date or '' if time is null
* @see dol_mktime, dol_stringtotime, dol_getdate * @see dol_mktime, dol_stringtotime, dol_getdate
*/ */
@ -2285,10 +2286,12 @@ function restrictedArea($user, $features='societe', $objectid=0, $dbtablename=''
/** /**
* Affiche message erreur de type acces interdit et arrete le programme * Show a message to say access is forbidden and stop program
* L'appel a cette fonction termine le code. * Calling this function terminate execution of PHP.
* @param message Force error message * @param message Force error message
* @param printheader Affiche avant le header * @param printheader Show header before
* @param printfooter Show footer after
* @param showonlymessage Show only message parameter. Otherwise add more information.
*/ */
function accessforbidden($message='',$printheader=1,$printfooter=1,$showonlymessage=0) function accessforbidden($message='',$printheader=1,$printfooter=1,$showonlymessage=0)
{ {
@ -3369,8 +3372,9 @@ function dol_htmlcleanlastbr($stringtodecode)
/** /**
* This function is called to decode a string with HTML entities (it decodes entities tags) * This function is called to decode a string with HTML entities (it decodes entities tags)
* @param string stringhtml * @param stringhtml stringhtml
* @return string decodestring * @param pagecodeto Encoding of input string
* @return string decodestring
*/ */
function dol_entity_decode($stringhtml,$pagecodeto='UTF-8') function dol_entity_decode($stringhtml,$pagecodeto='UTF-8')
{ {
@ -3380,9 +3384,10 @@ function dol_entity_decode($stringhtml,$pagecodeto='UTF-8')
/** /**
* Replace html_entity_decode functions to manage errors * Replace html_entity_decode functions to manage errors
* @param unknown_type $a * @param a
* @param unknown_type $b * @param b
* @param unknown_type $c * @param c
* @return string String decoded
*/ */
function dol_html_entity_decode($a,$b,$c) function dol_html_entity_decode($a,$b,$c)
{ {
@ -3393,9 +3398,10 @@ function dol_html_entity_decode($a,$b,$c)
/** /**
* Replace htmlentities functions to manage errors * Replace htmlentities functions to manage errors
* @param unknown_type $a * @param a
* @param unknown_type $b * @param b
* @param unknown_type $c * @param c
* @return string String encoded
*/ */
function dol_htmlentities($a,$b,$c) function dol_htmlentities($a,$b,$c)
{ {
@ -3489,7 +3495,7 @@ function dol_microtime_float()
return ((float)$usec + (float)$sec); return ((float)$usec + (float)$sec);
} }
/* /**
* Return if a text is a html content * Return if a text is a html content
* @param msg Content to check * @param msg Content to check
* @param option 0=Full detection, 1=Fast check * @param option 0=Full detection, 1=Fast check