From 30f22f7d77d1eaf96d5d2d72cda960af55074125 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 9 Jan 2005 18:30:34 +0000 Subject: [PATCH] Doc: documentation doxygen --- htdocs/cactioncomm.class.php | 5 ++--- htdocs/comm/mailing/index.php | 10 +++++----- htdocs/fichinter/fichinter.class.php | 14 +++++++++++++- htdocs/main.inc.php | 3 ++- htdocs/notify.class.php | 16 +++++++++++++--- htdocs/product/fournisseurs.php | 2 +- htdocs/telephonie/tarifs/index.php | 2 +- 7 files changed, 37 insertions(+), 15 deletions(-) diff --git a/htdocs/cactioncomm.class.php b/htdocs/cactioncomm.class.php index a7be524b2fc..3426eee0e20 100644 --- a/htdocs/cactioncomm.class.php +++ b/htdocs/cactioncomm.class.php @@ -21,15 +21,14 @@ * */ -/*! - \file htdocs/cactioncomm.class.php +/** \file htdocs/cactioncomm.class.php \ingroup commercial \brief Fichier de la classe des types d'actions commerciales \version $Revision$ */ -/*! \class CActionComm +/** \class CActioncomm \brief Classe permettant la gestion des différents types d'actions commerciales */ diff --git a/htdocs/comm/mailing/index.php b/htdocs/comm/mailing/index.php index 0d46595b2b4..368c03511d7 100644 --- a/htdocs/comm/mailing/index.php +++ b/htdocs/comm/mailing/index.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,11 +21,10 @@ * */ -/*! - \file htdocs/comm/index.php - \ingroup commercial - \brief Page acceuil de la zone mailing - \version $Revision$ +/** \file htdocs/comm/mailing/index.php + \ingroup commercial + \brief Page accueil de la zone mailing + \version $Revision$ */ require("./pre.inc.php"); diff --git a/htdocs/fichinter/fichinter.class.php b/htdocs/fichinter/fichinter.class.php index 34df2091ccf..b7b7be5b610 100644 --- a/htdocs/fichinter/fichinter.class.php +++ b/htdocs/fichinter/fichinter.class.php @@ -1,5 +1,6 @@ + * 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 @@ -20,7 +21,18 @@ * */ -class Fichinter +/** \file htdocs/fichinter/fichinter.class.php + \ingroup fucheinter + \brief Fichier de la classe des gestion des fiches interventions + \version $Revision$ +*/ + + +/** \class Ficheinter + \brief Classe des gestion des fiches interventions +*/ + +class Fichinter { var $id; var $db; diff --git a/htdocs/main.inc.php b/htdocs/main.inc.php index 41547e49e9c..9b70639c28e 100644 --- a/htdocs/main.inc.php +++ b/htdocs/main.inc.php @@ -110,7 +110,7 @@ if (defined("MAIN_NOT_INSTALLED")) * \brief Affiche en-tête html + la barre de menu supérieure * \param head lignes d'en-tete head * \param title titre page web - * \param head target du menu Accueil + * \param target target du menu Accueil */ function top_menu($head, $title="", $target="") @@ -313,6 +313,7 @@ function left_menu($menu, $help_url='', $form_search='') * \param urlaction url du post * \param urlobject url du lien sur titre de la zone de recherche * \param title titre de la zone de recherche + * \param htmlmodesearch 'search' * \param htmlinputname nom du champ input du formulaire */ diff --git a/htdocs/notify.class.php b/htdocs/notify.class.php index f0d0a5d2a17..15a2d0dc4ed 100644 --- a/htdocs/notify.class.php +++ b/htdocs/notify.class.php @@ -1,6 +1,6 @@ - * Copyright (C) 2004 Laurent Destailleur +/* Copyright (C) 2003 Rodolphe Quiedeville + * 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,7 +21,17 @@ * */ -class Notify +/** \file htdocs/notify.class.php + \brief Fichier de la classe de gestion des notifications + \version $Revision$ +*/ + + +/** \class Notify + \brief Classe de gestion des notifications +*/ + +class Notify { var $id; var $db; diff --git a/htdocs/product/fournisseurs.php b/htdocs/product/fournisseurs.php index c286a6f0ef8..af18b130211 100644 --- a/htdocs/product/fournisseurs.php +++ b/htdocs/product/fournisseurs.php @@ -21,7 +21,7 @@ * */ -/** \file htdocs/product/fournisseur.php +/** \file htdocs/product/fournisseurs.php \ingroup product,fournisseur \brief Page fournisseur de produit \version $Revision$ diff --git a/htdocs/telephonie/tarifs/index.php b/htdocs/telephonie/tarifs/index.php index b4d069f8c8e..16cc39517a4 100644 --- a/htdocs/telephonie/tarifs/index.php +++ b/htdocs/telephonie/tarifs/index.php @@ -20,7 +20,7 @@ * */ -/** \file htdocs/telephonie/tarif/index.php +/** \file htdocs/telephonie/tarifs/index.php \ingroup telephonie \brief Page accueil tarif telephonie \version $Revision$