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

ajout des commentaires pour doxygen

Browse Source
This commit is contained in:
opensides 2004-07-15 11:38:43 +00:00
parent 99ddf92856
commit 5814583adb
5 changed files with 178 additions and 242 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/dolibarr-doxygen
View File

@ -242,14 +242,14 @@ EXTRACT_LOCAL_METHODS = NO
# various overviews, but no documentation section is generated. # various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled. # This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. # undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various # If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled. # overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = NO HIDE_UNDOC_CLASSES = YES
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations. # friend (class|struct|union) declarations.
@ -416,7 +416,10 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = htdocs #INPUT = htdocs \
# htdocs/lib
INPUT = htdocs/lib
# If the value of the INPUT tag contains directories, you can use the # If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@ -702,7 +705,7 @@ COMPACT_LATEX = NO
# by the printer. Possible values are: a4, a4wide, letter, legal and # by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used. # executive. If left blank a4wide will be used.
PAPER_TYPE = a4wide PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output. # packages that should be included in the LaTeX output.

321
htdocs/lib/mysql.lib.php
View File

@ -22,18 +22,15 @@
* *
*/ */
/** /*! \file mysql.lib.php
* classe DoliDb \brief contenant les fonctions pour gere la database de dolibarr.
* \author Fabien Seisen
* Classe contenant les fonctions pour gere la database de dolibarr \author Rodolphe Quiedeville.
* \author Laurent Destailleur.
* @package mysql.lib.php \version 1.2.
* @author Fabien Seisen
* @author Rodolphe Quiedeville Ensemble des fonctions permettant de gérer la database de dolibarr.
* @author Laurent Destailleur */
* @version 1.2
*
*/
class DoliDb { class DoliDb {
var $db, $results, $ok, $connected, $database_selected; var $db, $results, $ok, $connected, $database_selected;
@ -42,17 +39,14 @@ class DoliDb {
var $ERROR_DUPLICATE=1062; var $ERROR_DUPLICATE=1062;
var $ERROR_TABLEEXISTS=1050; var $ERROR_TABLEEXISTS=1050;
/*!
/** \brief ouverture d'une connection vers le serveur et/ou une database.
* ouverture d'une connection vers le serveur et/ou une database \param type type de base de données (mysql ou pgsql)
* \param host addresse de la base de données
* @access public \param user nom de l'utilisateur autorisé
* @param string $type \param pass mot de passe
* @param string $host \param name nom de la database
* @param string $user */
* @param string $pass
* @param string $name
*/
Function DoliDb($type = 'mysql', $host = '', $user = '', $pass = '', $name = '') Function DoliDb($type = 'mysql', $host = '', $user = '', $pass = '', $name = '')
@ -127,28 +121,24 @@ class DoliDb {
return $this->ok; return $this->ok;
} }
/** /*!
* selectionne une database \brief selectionne une database.
* \param database nom de la database
* @access public \return resource
* @param string $database */
* @return resource
*/
Function select_db($database) Function select_db($database)
{ {
return mysql_select_db($database, $this->db); return mysql_select_db($database, $this->db);
} }
/** /*!
* connection vers une database \brief connection vers une database.
* \param host addresse de la base de données
* @access public \param login nom de l'utilisateur autorisé
* @param string $host \param pass mot de passe
* @param string $login \return resource
* @param string $passwd */
* @return resource
*/
Function connect($host, $login, $passwd) Function connect($host, $login, $passwd)
{ {
@ -157,13 +147,11 @@ class DoliDb {
return $this->db; return $this->db;
} }
/** /*!
* création d'une database \brief création d'une database.
* \param database nom de la database
* @access public \return result resultat 1 pour ok, 0 pour non ok
* @param string $database */
* @return integer
*/
Function create_db($database) Function create_db($database)
{ {
@ -177,12 +165,10 @@ class DoliDb {
} }
} }
/** /*!
* copie d'une database \brief copie d'une database.
* \return resource
* @access public */
* @return resource
*/
Function clone() Function clone()
{ {
@ -191,15 +177,13 @@ class DoliDb {
return $db2; return $db2;
} }
/** /*!
* ouverture d'une connection vers une database \brief ouverture d'une connection vers une database.
* \param host addresse de la base de données
* @access public \param login nom de l'utilisateur autorisé
* @param string $host \param pass mot de passe
* @param string $login \return resource
* @param string $passwd */
* @return resource
*/
Function pconnect($host, $login, $passwd) Function pconnect($host, $login, $passwd)
{ {
@ -207,25 +191,21 @@ class DoliDb {
return $this->db; return $this->db;
} }
/** /*!
* fermeture d'une connection vers une database \brief fermeture d'une connection vers une database.
* \return resource
* @access public */
* @return resource
*/
Function close() Function close()
{ {
return mysql_close($this->db); return mysql_close($this->db);
} }
/** /*!
* debut d'un transaction \brief debut d'une transaction.
* \param do
* @access public \return string
* @param integer $do */
* @return string
*/
Function begin($do=1) Function begin($do=1)
{ {
@ -239,13 +219,11 @@ class DoliDb {
} }
} }
/** /*!
* écriture d'un transaction \brief écriture d'une transaction.
* \param do
* @access public \return string
* @param integer $do */
* @return string
*/
Function commit($do=1) Function commit($do=1)
{ {
@ -259,13 +237,11 @@ class DoliDb {
} }
} }
/** /*!
* effacement d'un transaction et retour au ancienne valeurs \brief éffacement d'une transaction et retour au ancienne valeurs.
* \param do
* @access public \return string
* @param integer $do */
* @return string
*/
Function rollback($do=1) Function rollback($do=1)
{ {
@ -279,15 +255,13 @@ class DoliDb {
} }
} }
/** /*!
* requete vers une database \brief requete vers une database.
* \param query contenu de la query
* @access public \param limit
* @param string $query \param offset
* @param string $limit \return resource
* @param string $offset */
* @return resource
*/
Function query($query, $limit="", $offset="") Function query($query, $limit="", $offset="")
{ {
@ -297,13 +271,11 @@ class DoliDb {
return $this->results; return $this->results;
} }
/** /*!
* liste des tables vers une database \brief liste des tables dans une database.
* \param database nom de la database
* @access public \return resource
* @param string $database */
* @return resource
*/
Function list_tables($database) Function list_tables($database)
{ {
@ -311,52 +283,44 @@ class DoliDb {
return $this->results; return $this->results;
} }
/** /*!
* renvoie les données de la requete \brief renvoie les données de la requete.
* \param nb contenu de la query
* @access public \param string nom du champ
* @param integer $nb \return resource
* @param string $fieldname */
* @return resource
*/
Function result($nb, $fieldname) Function result($nb, $fieldname)
{ {
return mysql_result($this->results, $nb, $fieldname); return mysql_result($this->results, $nb, $fieldname);
} }
/** /*!
* désalloue la memoire de la requete \brief désalloue la memoire de la requete.
* \return resource
* @access public */
* @return resource
*/
Function free() Function free()
{ {
return mysql_free_result($this->results); return mysql_free_result($this->results);
} }
/** /*!
* renvoie les données comme un objet \brief renvoie les données comme un objet.
* \return resource
* @access public */
* @return resource
*/
Function fetch_object() Function fetch_object()
{ {
return mysql_fetch_object($this->results); return mysql_fetch_object($this->results);
} }
/** /*!
* défini les limites de la requète \brief défini les limites de la requète.
* \param limit
* @access public \param offset
* @param integer $limit \return limit
* @param integer $offset */
* @return string
*/
Function plimit($limit=0,$offset=0) Function plimit($limit=0,$offset=0)
{ {
@ -376,37 +340,31 @@ class DoliDb {
return "unix_timestamp($fname)"; return "unix_timestamp($fname)";
} }
/** /*!
* formatage de la date en fonction des locales \brief formatage de la date en fonction des locales.
* \param fname
* @access public \return date
* @param integer $fname */
* @return string
*/
Function idate($fname) Function idate($fname)
{ {
return strftime("%Y%m%d%H%M%S",$fname); return strftime("%Y%m%d%H%M%S",$fname);
} }
/** /*!
* renvoie les données dans un tableau \brief renvoie les données dans un tableau.
* \return array
* @access public */
* @return array
*/
Function fetch_array() Function fetch_array()
{ {
return mysql_fetch_array($this->results); return mysql_fetch_array($this->results);
} }
/** /*!
* renvoie les données comme un tableau \brief renvoie les données comme un tableau.
* \return array
* @access public */
* @return array
*/
Function fetch_row() Function fetch_row()
{ {
@ -425,48 +383,41 @@ class DoliDb {
return mysql_fetch_field($this->results); return mysql_fetch_field($this->results);
} }
/**
* renvoie le nombre de lignes dans le resultat de la requete /*!
* \brief renvoie le nombre de lignes dans le resultat de la requete.
* @access public \return int
* @return int */
*/
Function num_rows() Function num_rows()
{ {
return mysql_num_rows($this->results); return mysql_num_rows($this->results);
} }
/** /*!
* renvoie le nombre de champs dans le resultat de la requete \brief renvoie le nombre de champs dans le resultat de la requete.
* \return int
* @access public */
* @return int
*/
Function num_fields() Function num_fields()
{ {
return mysql_num_fields($this->results); return mysql_num_fields($this->results);
} }
/** /*!
* renvoie le texte de l'erreur mysql de l'operation precedente \brief renvoie le texte de l'erreur mysql de l'operation precedente.
* \return error_text
* @access public */
* @return string
*/
Function error() Function error()
{ {
return mysql_error($this->db); return mysql_error($this->db);
} }
/** /*!
* renvoie la valeur numerique de l'erreur mysql de l'operation precedente \brief renvoie la valeur numerique de l'erreur mysql de l'operation precedente.
* \return error_num
* @access public */
* @return int
*/
Function errno() Function errno()
{ {
@ -476,24 +427,20 @@ class DoliDb {
return mysql_errno($this->db); return mysql_errno($this->db);
} }
/** /*!
* obtient l'id genéré par le précedent INSERT \brief obtient l'id genéré par le précedent INSERT.
* \return id
* @access public */
* @return int
*/
Function last_insert_id() Function last_insert_id()
{ {
return mysql_insert_id(); return mysql_insert_id();
} }
/** /*!
* obtient le nombre de lignes affectées dans la précédente opération \brief obtient le nombre de lignes affectées dans la précédente opération.
* \return rows
* @access public */
* @return int
*/
Function affected_rows() Function affected_rows()
{ {

31
htdocs/lib/price.lib.php
View File

@ -20,23 +20,20 @@
* *
*/ */
/** /*! \file price.lib.php
* librairie contenant les fonctions pour calculer un prix \brief librairie contenant les fonctions pour calculer un prix.
* \author Rodolphe Quiedeville.
* @package price.lib.php \version 1.2.
* @author Rodolphe Quiedeville
* @version 1.2
*
*/
/** Ensemble des fonctions permettant de calculer un prix.
* permet de calculer un prix */
*
* @access public /*!
* @param integer $products \brief permet de calculer un prix
* @param integer $remise_percent \param products
* @return integer $result \param remise_percent
*/ \return result
*/
Function calcul_price($products, $remise_percent) Function calcul_price($products, $remise_percent)
{ {
@ -45,7 +42,7 @@ Function calcul_price($products, $remise_percent)
$tva = array(); $tva = array();
$total_tva = 0; $total_tva = 0;
$total_remise = 0; $total_remise = 0;
$num = sizeof($products); $num = sizeof($products);
$i = 0; $i = 0;

38
htdocs/lib/thermometer.php
View File

@ -21,29 +21,27 @@
* *
*/ */
/** /*! \file thermometer.php
* librairie contenant les fonctions pour afficher un thermometre \brief Classe permettant d'afficher un thermometre.
* monetaire \author Rodolphe Quiedeville.
* \author Timothy Kanters.
* @package thermometer.php \version 1.2.
* @author Timothy Kanters
* @author Rodolphe Quiedeville Ensemble des fonctions permettant d'afficher un thermometre monetaire.
* @version 1.2 */
*
*/ /*!
\brief permet d'afficher un thermometre monetaire.
\param actualValue
\param pendingValue
\param intentValue
\return thermometer htmlLegenda
*/
/**
* permet d'afficher un thermometre monetaire
*
* @access public
* @param integer $actualValue
* @param integer $pendingValue
* @param integer $intendValue
* @return string $thermometer $htmlLegenda
*/
function moneyMeter($actualValue=0, $pendingValue=0, $intentValue=0) function moneyMeter($actualValue=0, $pendingValue=0, $intentValue=0)
/*
/*
This function returns the html for the moneymeter. This function returns the html for the moneymeter.
cachedValue: amount of actual money cachedValue: amount of actual money
pendingValue: amount of money of pending memberships pendingValue: amount of money of pending memberships

19
htdocs/lib/webcal.class.php
View File

@ -21,14 +21,11 @@
*/ */
/*! \file webcal.class.php /*! \file webcal.class.php
\brief Classe permettant d'acceder a la database webcalendar.
\author Rodolphe Quiedeville.
\version 1.2.
Ensemble des fonctions permettant d'acceder a la database webcalendar.
*/
/*! \class Webcal webcal.class.php
\brief Classe permettant d'acceder a la database webcalendar
Details des fonctions permettant d'acceder a la database webcalendar
*/ */
class Webcal { class Webcal {
@ -37,9 +34,7 @@ class Webcal {
var $duree = 0; var $duree = 0;
/*! /*!
\static \brief Permet de se connecter a la database webcalendar.
Permet de se connecter a la database.
*/ */
Function Webcal() Function Webcal()
@ -54,15 +49,12 @@ class Webcal {
} }
/*! /*!
\static
\brief ajoute une entree dans le calendrier de l'utilsateur \brief ajoute une entree dans le calendrier de l'utilsateur
\param[in] $user le login de l'utilisateur \param[in] $user le login de l'utilisateur
\param[in] $date la date de l'evenement dans le calendrier \param[in] $date la date de l'evenement dans le calendrier
\param[in] $texte le titre a indiquer dans l'evenement \param[in] $texte le titre a indiquer dans l'evenement
\param[in] $desc la description a indiquer dans l'evenement \param[in] $desc la description a indiquer dans l'evenement
*/ */
Function add($user, $date, $texte, $desc) Function add($user, $date, $texte, $desc)
@ -113,7 +105,6 @@ class Webcal {
} }
/*! /*!
\static
\brief obtient l'id suivant dans le webcalendar \brief obtient l'id suivant dans le webcalendar
\retval $id retourne l'id suivant dans le webcalendar \retval $id retourne l'id suivant dans le webcalendar