From 52239325b4feb5627218fee427fcf670ebbd53a7 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 9 Jan 2005 17:55:45 +0000 Subject: [PATCH] Doc: documentation doxygen --- htdocs/lib/dolibarrmail.class.php | 10 +--------- htdocs/lib/mysql.lib.php | 4 ++-- htdocs/lib/pgsql.lib.php | 4 ++-- htdocs/product/stock/entrepot.class.php | 11 +++++++++++ htdocs/product/stock/fiche.php | 2 +- htdocs/product/stock/index.php | 3 ++- htdocs/product/stock/liste.php | 7 +++++++ htdocs/product/stock/mouvement.php | 2 +- htdocs/product/stock/mouvementstock.class.php | 12 ++++++++++++ htdocs/product/stock/pre.inc.php | 3 +-- htdocs/product/stock/product.php | 5 ++--- htdocs/telephonie/ligne/infoc.php | 6 ++++++ htdocs/telephonie/ligne/listecommande.php | 7 +++++++ htdocs/telephonie/ligne/numdata.php | 7 +++++++ htdocs/telephonie/tarifs/index.php | 7 +++++++ 15 files changed, 69 insertions(+), 21 deletions(-) diff --git a/htdocs/lib/dolibarrmail.class.php b/htdocs/lib/dolibarrmail.class.php index 7787a4344fe..64b9e999dc1 100644 --- a/htdocs/lib/dolibarrmail.class.php +++ b/htdocs/lib/dolibarrmail.class.php @@ -59,11 +59,6 @@ class DolibarrMail \param to \param from \param msg - \param filename_list - \param mimetype_list - \param mimefilename_list - \param addr_cc - \param addr_bcc */ function DolibarrMail($subject, $to, $from, $msg) @@ -213,10 +208,9 @@ class DolibarrMail fputs($fp, $message_comp); fclose($fp); } + /** \brief permet d'ecrire le corps du message - \param msgtext - \param filename_list */ function write_body() @@ -264,8 +258,6 @@ class DolibarrMail /** \brief création des headers smtp - \param addr_from - \param addr_cc */ function write_smtpheaders() diff --git a/htdocs/lib/mysql.lib.php b/htdocs/lib/mysql.lib.php index 0e6cf4eecde..a498b3eb531 100644 --- a/htdocs/lib/mysql.lib.php +++ b/htdocs/lib/mysql.lib.php @@ -395,7 +395,7 @@ class DoliDb /*! \brief Renvoie le nombre de lignes dans le resultat d'une requete SELECT - \seealso affected_rows + \see affected_rows \return int nombre de lignes */ @@ -407,7 +407,7 @@ class DoliDb /*! \brief Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE - \seealso num_rows + \see num_rows \return int nombre de lignes */ diff --git a/htdocs/lib/pgsql.lib.php b/htdocs/lib/pgsql.lib.php index 64c26ae8b04..62bb1b517e1 100644 --- a/htdocs/lib/pgsql.lib.php +++ b/htdocs/lib/pgsql.lib.php @@ -409,7 +409,7 @@ class DoliDb /*! \brief Renvoie le nombre de lignes dans le resultat d'une requete SELECT - \seealso affected_rows + \see affected_rows \return int nombre de lignes */ @@ -421,7 +421,7 @@ class DoliDb /*! \brief Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE - \seealso num_rows + \see num_rows \return int nombre de lignes */ diff --git a/htdocs/product/stock/entrepot.class.php b/htdocs/product/stock/entrepot.class.php index 23b4ad4320f..6506cf99639 100644 --- a/htdocs/product/stock/entrepot.class.php +++ b/htdocs/product/stock/entrepot.class.php @@ -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 { var $db ; diff --git a/htdocs/product/stock/fiche.php b/htdocs/product/stock/fiche.php index 04248a5266c..e2946fed611 100644 --- a/htdocs/product/stock/fiche.php +++ b/htdocs/product/stock/fiche.php @@ -22,7 +22,7 @@ */ /** \file htdocs/product/stock/fiche.php - \group stock + \ingroup stock \brief Page fiche entrepot \version $Revision$ */ diff --git a/htdocs/product/stock/index.php b/htdocs/product/stock/index.php index 0a22353a120..d487f42eafd 100644 --- a/htdocs/product/stock/index.php +++ b/htdocs/product/stock/index.php @@ -21,7 +21,8 @@ * */ -/*! \file htdocs/product/stock/index.php +/** \file htdocs/product/stock/index.php + \ingroup stock \brief Page accueil stocks produits \version $Revision$ */ diff --git a/htdocs/product/stock/liste.php b/htdocs/product/stock/liste.php index 29827e1a0b1..173fc73da4e 100644 --- a/htdocs/product/stock/liste.php +++ b/htdocs/product/stock/liste.php @@ -20,6 +20,13 @@ * $Source$ * */ + +/** \file htdocs/product/stock/liste.php + \ingroup stock + \brief Page liste des stocks + \version $Revision$ +*/ + require("./pre.inc.php"); $user->getrights('produit'); diff --git a/htdocs/product/stock/mouvement.php b/htdocs/product/stock/mouvement.php index 9226050d805..abbdc882624 100644 --- a/htdocs/product/stock/mouvement.php +++ b/htdocs/product/stock/mouvement.php @@ -22,7 +22,7 @@ */ /** \file htdocs/product/stock/mouvement.php - \group stock + \ingroup stock \brief Page liste des mouvements de stocks \version $Revision$ */ diff --git a/htdocs/product/stock/mouvementstock.class.php b/htdocs/product/stock/mouvementstock.class.php index 5968132a40a..36271dabb30 100644 --- a/htdocs/product/stock/mouvementstock.class.php +++ b/htdocs/product/stock/mouvementstock.class.php @@ -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 { @@ -27,6 +38,7 @@ class MouvementStock { $this->db = $DB; } + /* * * diff --git a/htdocs/product/stock/pre.inc.php b/htdocs/product/stock/pre.inc.php index 83cc0264bbf..0fb05bee07b 100644 --- a/htdocs/product/stock/pre.inc.php +++ b/htdocs/product/stock/pre.inc.php @@ -21,8 +21,7 @@ * */ -/*! - \file htdocs/product/stock/pre.inc.php +/** \file htdocs/product/stock/pre.inc.php \ingroup stock \brief Fichier gestionnaire du menu gauche de stocks \version $Revision$ diff --git a/htdocs/product/stock/product.php b/htdocs/product/stock/product.php index ca229632a8e..2e9d605bb19 100644 --- a/htdocs/product/stock/product.php +++ b/htdocs/product/stock/product.php @@ -22,9 +22,8 @@ * */ -/*! - \file htdocs/product/stock/product.php - \ingroup product +/** \file htdocs/product/stock/product.php + \ingroup stock \brief Page de la fiche produit \version $Revision$ */ diff --git a/htdocs/telephonie/ligne/infoc.php b/htdocs/telephonie/ligne/infoc.php index 9609f649dab..4d14598f8c5 100644 --- a/htdocs/telephonie/ligne/infoc.php +++ b/htdocs/telephonie/ligne/infoc.php @@ -20,6 +20,12 @@ * */ +/** \file htdocs/telephonie/ligne/infoc.php + \ingroup telephonie + \brief Lignes telephonie + \version $Revision$ +*/ + require("./pre.inc.php"); $mesg = ''; diff --git a/htdocs/telephonie/ligne/listecommande.php b/htdocs/telephonie/ligne/listecommande.php index 155552fc140..5545d01a55c 100644 --- a/htdocs/telephonie/ligne/listecommande.php +++ b/htdocs/telephonie/ligne/listecommande.php @@ -19,6 +19,13 @@ * $Source$ * */ + +/** \file htdocs/telephonie/ligne/listecommande.php + \ingroup telephonie + \brief Liste commandes + \version $Revision$ +*/ + require("./pre.inc.php"); diff --git a/htdocs/telephonie/ligne/numdata.php b/htdocs/telephonie/ligne/numdata.php index af4b6f0fc20..58345783bee 100644 --- a/htdocs/telephonie/ligne/numdata.php +++ b/htdocs/telephonie/ligne/numdata.php @@ -19,6 +19,13 @@ * $Source$ * */ + +/** \file htdocs/telephonie/ligne/numdata.php + \ingroup telephonie + \brief Num data + \version $Revision$ +*/ + require("./pre.inc.php"); diff --git a/htdocs/telephonie/tarifs/index.php b/htdocs/telephonie/tarifs/index.php index 67d6b369d0f..b4d069f8c8e 100644 --- a/htdocs/telephonie/tarifs/index.php +++ b/htdocs/telephonie/tarifs/index.php @@ -19,6 +19,13 @@ * $Source$ * */ + +/** \file htdocs/telephonie/tarif/index.php + \ingroup telephonie + \brief Page accueil tarif telephonie + \version $Revision$ +*/ + require("./pre.inc.php");