From bfc043efbc02dfa90a530ab6d4ed359d49ef54a9 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 9 Jan 2005 18:10:37 +0000 Subject: [PATCH] Doc: documentation doxygen --- htdocs/comm/addpropal.php | 9 ++++----- htdocs/compta/paiement/rapport.php | 4 ++-- htdocs/fourn/facture/paiement.php | 8 ++++---- htdocs/fournisseur.commande.class.php | 13 +++++++------ htdocs/main.inc.php | 9 ++++----- htdocs/product/fournisseurs.php | 9 ++++----- 6 files changed, 25 insertions(+), 27 deletions(-) diff --git a/htdocs/comm/addpropal.php b/htdocs/comm/addpropal.php index 9a60e7c2d41..623a7d62333 100644 --- a/htdocs/comm/addpropal.php +++ b/htdocs/comm/addpropal.php @@ -1,6 +1,6 @@ - * Copyright (C) 2004 Laurent Destailleur + * Copyright (C) 2004-2005 Laurent Destailleur * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -21,10 +21,9 @@ * */ -/*! - \file htdocs/comm/prospect/prospect.php - \ingroup prospect - \brief Page de la liste des prospects +/** \file htdocs/comm/addpropal.php + \ingroup propal + \brief Page d'ajout d'une proposition commmercial \version $Revision$ */ diff --git a/htdocs/compta/paiement/rapport.php b/htdocs/compta/paiement/rapport.php index 0ddc47b3a54..4f54f9caa80 100644 --- a/htdocs/compta/paiement/rapport.php +++ b/htdocs/compta/paiement/rapport.php @@ -21,9 +21,9 @@ * */ -/** \file htdocs/compta/paiement/fiche.php +/** \file htdocs/compta/paiement/rapport.php \ingroup facture - \brief Onglet paiement d'un paiement + \brief Rapports de paiements \version $Revision$ */ diff --git a/htdocs/fourn/facture/paiement.php b/htdocs/fourn/facture/paiement.php index ae21928770c..337747cbaad 100644 --- a/htdocs/fourn/facture/paiement.php +++ b/htdocs/fourn/facture/paiement.php @@ -1,7 +1,7 @@ * Copyright (C) 2004 Éric Seigne - * Copyright (C) 2004 Laurent Destailleur + * Copyright (C) 2004-2005 Laurent Destailleur * Copyright (C) 2004 Christophe Combelles * * This program is free software; you can redistribute it and/or modify @@ -23,9 +23,9 @@ * */ -/*! \file htdocs/comm/propal/note.php - \ingroup propale - \brief Fiche d'information sur une proposition commerciale +/** \file htdocs/fourn/facture/paiement.php + \ingroup fournisseur,facture + \brief Paiements des factures fournisseurs \version $Revision$ */ diff --git a/htdocs/fournisseur.commande.class.php b/htdocs/fournisseur.commande.class.php index ebe000774b9..d47d1cbdd8a 100644 --- a/htdocs/fournisseur.commande.class.php +++ b/htdocs/fournisseur.commande.class.php @@ -21,15 +21,15 @@ * */ -/*! \file htdocs/commande/commande.class.php - \ingroup commande - \brief Fichier des classes de commandes +/** \file htdocs/fournisseur.commande.class.php + \ingroup fournisseur,commande + \brief Fichier des classes des commandes fournisseurs \version $Revision$ */ -/*! \class Commande - \brief Classe de gestion de commande +/** \class CommandeFournisseur + \brief Classe de gestion de commande fournisseur */ class CommandeFournisseur @@ -38,7 +38,8 @@ class CommandeFournisseur var $id ; var $brouillon; - /*! \brief Constructeur + /** \brief Constructeur + * \param DB Handler d'accès aux bases de données */ function CommandeFournisseur($DB) { diff --git a/htdocs/main.inc.php b/htdocs/main.inc.php index 218820d7218..41547e49e9c 100644 --- a/htdocs/main.inc.php +++ b/htdocs/main.inc.php @@ -1,7 +1,7 @@ * Copyright (C) 2003 Xavier Dutoit - * Copyright (C) 2004 Laurent Destailleur + * Copyright (C) 2004-2005 Laurent Destailleur * Copyright (C) 2004 Sebastien Di Cintio * Copyright (C) 2004 Benoit Mortier * @@ -24,10 +24,9 @@ * */ -/** - \file htdocs/master.inc.php - \brief Fichier de formatage générique des ecrans Dolibarr - \version $Revision$ +/** \file htdocs/main.inc.php + \brief Fichier de formatage générique des ecrans Dolibarr + \version $Revision$ */ require("master.inc.php"); diff --git a/htdocs/product/fournisseurs.php b/htdocs/product/fournisseurs.php index 7bc5ae27c73..c286a6f0ef8 100644 --- a/htdocs/product/fournisseurs.php +++ b/htdocs/product/fournisseurs.php @@ -1,6 +1,6 @@ - * Copyright (C) 2004 Laurent Destailleur + * Copyright (C) 2004-2005 Laurent Destailleur * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -21,10 +21,9 @@ * */ -/*! - \file htdocs/product/fiche.php - \ingroup product - \brief Page de la fiche produit +/** \file htdocs/product/fournisseur.php + \ingroup product,fournisseur + \brief Page fournisseur de produit \version $Revision$ */