Doc: documentation doxygen

This commit is contained in:
Laurent Destailleur 2005-01-09 17:55:45 +00:00
parent 2e6b3bdf34
commit 52239325b4
15 changed files with 69 additions and 21 deletions

View File

@ -59,11 +59,6 @@ class DolibarrMail
\param to \param to
\param from \param from
\param msg \param msg
\param filename_list
\param mimetype_list
\param mimefilename_list
\param addr_cc
\param addr_bcc
*/ */
function DolibarrMail($subject, $to, $from, $msg) function DolibarrMail($subject, $to, $from, $msg)
@ -213,10 +208,9 @@ class DolibarrMail
fputs($fp, $message_comp); fputs($fp, $message_comp);
fclose($fp); fclose($fp);
} }
/** /**
\brief permet d'ecrire le corps du message \brief permet d'ecrire le corps du message
\param msgtext
\param filename_list
*/ */
function write_body() function write_body()
@ -264,8 +258,6 @@ class DolibarrMail
/** /**
\brief création des headers smtp \brief création des headers smtp
\param addr_from
\param addr_cc
*/ */
function write_smtpheaders() function write_smtpheaders()

View File

@ -395,7 +395,7 @@ class DoliDb
/*! /*!
\brief Renvoie le nombre de lignes dans le \brief Renvoie le nombre de lignes dans le
resultat d'une requete SELECT resultat d'une requete SELECT
\seealso affected_rows \see affected_rows
\return int nombre de lignes \return int nombre de lignes
*/ */
@ -407,7 +407,7 @@ class DoliDb
/*! /*!
\brief Renvoie le nombre de lignes dans le \brief Renvoie le nombre de lignes dans le
resultat d'une requete INSERT, DELETE ou UPDATE resultat d'une requete INSERT, DELETE ou UPDATE
\seealso num_rows \see num_rows
\return int nombre de lignes \return int nombre de lignes
*/ */

View File

@ -409,7 +409,7 @@ class DoliDb
/*! /*!
\brief Renvoie le nombre de lignes dans le \brief Renvoie le nombre de lignes dans le
resultat d'une requete SELECT resultat d'une requete SELECT
\seealso affected_rows \see affected_rows
\return int nombre de lignes \return int nombre de lignes
*/ */
@ -421,7 +421,7 @@ class DoliDb
/*! /*!
\brief Renvoie le nombre de lignes dans le \brief Renvoie le nombre de lignes dans le
resultat d'une requete INSERT, DELETE ou UPDATE resultat d'une requete INSERT, DELETE ou UPDATE
\seealso num_rows \see num_rows
\return int nombre de lignes \return int nombre de lignes
*/ */

View File

@ -21,6 +21,17 @@
* *
*/ */
/** \file htdocs/product/stock/entrepot.class.php
\ingroup stock
\brief Fichier de la classe de gestion des entrepots
\version $Revision$
*/
/** \class Entrepot
\brief Classe permettant la gestion des entrepots
*/
class Entrepot class Entrepot
{ {
var $db ; var $db ;

View File

@ -22,7 +22,7 @@
*/ */
/** \file htdocs/product/stock/fiche.php /** \file htdocs/product/stock/fiche.php
\group stock \ingroup stock
\brief Page fiche entrepot \brief Page fiche entrepot
\version $Revision$ \version $Revision$
*/ */

View File

@ -21,7 +21,8 @@
* *
*/ */
/*! \file htdocs/product/stock/index.php /** \file htdocs/product/stock/index.php
\ingroup stock
\brief Page accueil stocks produits \brief Page accueil stocks produits
\version $Revision$ \version $Revision$
*/ */

View File

@ -20,6 +20,13 @@
* $Source$ * $Source$
* *
*/ */
/** \file htdocs/product/stock/liste.php
\ingroup stock
\brief Page liste des stocks
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
$user->getrights('produit'); $user->getrights('produit');

View File

@ -22,7 +22,7 @@
*/ */
/** \file htdocs/product/stock/mouvement.php /** \file htdocs/product/stock/mouvement.php
\group stock \ingroup stock
\brief Page liste des mouvements de stocks \brief Page liste des mouvements de stocks
\version $Revision$ \version $Revision$
*/ */

View File

@ -20,6 +20,17 @@
* *
*/ */
/** \file htdocs/product/stock/mouvementstock.class.php
\ingroup stock
\brief Fichier de la classe de gestion des mouvements de stocks
\version $Revision$
*/
/** \class MouvementStock
\brief Classe permettant la gestion des mouvements de stocks
*/
class MouvementStock class MouvementStock
{ {
@ -27,6 +38,7 @@ class MouvementStock
{ {
$this->db = $DB; $this->db = $DB;
} }
/* /*
* *
* *

View File

@ -21,8 +21,7 @@
* *
*/ */
/*! /** \file htdocs/product/stock/pre.inc.php
\file htdocs/product/stock/pre.inc.php
\ingroup stock \ingroup stock
\brief Fichier gestionnaire du menu gauche de stocks \brief Fichier gestionnaire du menu gauche de stocks
\version $Revision$ \version $Revision$

View File

@ -22,9 +22,8 @@
* *
*/ */
/*! /** \file htdocs/product/stock/product.php
\file htdocs/product/stock/product.php \ingroup stock
\ingroup product
\brief Page de la fiche produit \brief Page de la fiche produit
\version $Revision$ \version $Revision$
*/ */

View File

@ -20,6 +20,12 @@
* *
*/ */
/** \file htdocs/telephonie/ligne/infoc.php
\ingroup telephonie
\brief Lignes telephonie
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");
$mesg = ''; $mesg = '';

View File

@ -19,6 +19,13 @@
* $Source$ * $Source$
* *
*/ */
/** \file htdocs/telephonie/ligne/listecommande.php
\ingroup telephonie
\brief Liste commandes
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");

View File

@ -19,6 +19,13 @@
* $Source$ * $Source$
* *
*/ */
/** \file htdocs/telephonie/ligne/numdata.php
\ingroup telephonie
\brief Num data
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");

View File

@ -19,6 +19,13 @@
* $Source$ * $Source$
* *
*/ */
/** \file htdocs/telephonie/tarif/index.php
\ingroup telephonie
\brief Page accueil tarif telephonie
\version $Revision$
*/
require("./pre.inc.php"); require("./pre.inc.php");