Wavyzz/dolibarr-fork
2
0
Fork 0
forked from Wavyzz/dolibarr
Code Pull Requests 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
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.
# 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
# undocumented classes that are normally visible in the class hierarchy.
# 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.
HIDE_UNDOC_CLASSES = NO
HIDE_UNDOC_CLASSES = YES
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
@@ -416,7 +416,10 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = htdocs
#INPUT = htdocs \
# htdocs/lib
INPUT = htdocs/lib
# 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
@@ -702,7 +705,7 @@ COMPACT_LATEX = NO
# by the printer. Possible values are: a4, a4wide, letter, legal and
# 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
# packages that should be included in the LaTeX output.

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

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

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

@@ -20,23 +20,20 @@
*
*/
/**
* librairie contenant les fonctions pour calculer un prix
*
* @package price.lib.php
* @author Rodolphe Quiedeville
* @version 1.2
*
*/
/*! \file price.lib.php
\brief librairie contenant les fonctions pour calculer un prix.
\author Rodolphe Quiedeville.
\version 1.2.
/**
* permet de calculer un prix
*
* @access public
* @param integer $products
* @param integer $remise_percent
* @return integer $result
*/
Ensemble des fonctions permettant de calculer un prix.
*/
/*!
\brief permet de calculer un prix
\param products
\param remise_percent
\return result
*/
Function calcul_price($products, $remise_percent)
{

38
htdocs/lib/thermometer.php
View File

@@ -21,29 +21,27 @@
*
*/
/**
* librairie contenant les fonctions pour afficher un thermometre
* monetaire
*
* @package thermometer.php
* @author Timothy Kanters
* @author Rodolphe Quiedeville
* @version 1.2
*
*/
/*! \file thermometer.php
\brief Classe permettant d'afficher un thermometre.
\author Rodolphe Quiedeville.
\author Timothy Kanters.
\version 1.2.
Ensemble des fonctions permettant d'afficher un thermometre monetaire.
*/
/*!
\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)
/*
/*
This function returns the html for the moneymeter.
cachedValue: amount of actual money
pendingValue: amount of money of pending memberships

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

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