From 582491bfed1762c0f5ffe93387247fc14a5da1e9 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 23 Jan 2005 02:14:56 +0000 Subject: [PATCH] Doc: Documentation doxygen --- htdocs/facture.class.php | 4 ++-- htdocs/project.class.php | 29 +++++++++++++++++++++++------ 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/htdocs/facture.class.php b/htdocs/facture.class.php index d3293a2db5f..d8b6315a2cb 100644 --- a/htdocs/facture.class.php +++ b/htdocs/facture.class.php @@ -31,7 +31,7 @@ */ -/*! \class Facture +/** \class Facture \brief Classe permettant la gestion des factures clients */ @@ -1265,7 +1265,7 @@ class Facture -/*! +/** \class FactureLigne \brief Classe permettant la gestion des lignes de factures */ diff --git a/htdocs/project.class.php b/htdocs/project.class.php index c3e39909a35..d3951594f9d 100644 --- a/htdocs/project.class.php +++ b/htdocs/project.class.php @@ -1,5 +1,6 @@ + * Copyright (C) 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 @@ -20,6 +21,17 @@ * */ +/** + \file htdocs/project.class.php + \ingroup projet + \brief Fichier de la classe de gestion des projets + \version $Revision$ +*/ + + +/** \class Project + \brief Classe permettant la gestion des projets +*/ class Project { var $id; @@ -28,14 +40,17 @@ class Project { var $title; var $socidp; + /** + * \brief Constructeur de la classe + * \param DB handler accès base de données + */ function Project($DB) { $this->db = $DB; } /* - * - * - * + * \brief Crée un projet en base + * \param creatorid id utilisateur qui crée */ function create($creatorid) { @@ -52,9 +67,8 @@ class Project { } /* - * - * - * + * \brief Charge objet projet depuis la base + * \param rowid id du projet à charger */ function fetch($rowid) { @@ -76,6 +90,7 @@ class Project { } } + /* * * @@ -113,6 +128,7 @@ class Project { print $this->db->error() . '
' .$sql; } } + /* * @@ -154,5 +170,6 @@ class Project { } } + } ?>