diff --git a/htdocs/includes/modules/propale/mod_propale_ivoire.php b/htdocs/includes/modules/propale/mod_propale_ivoire.php index 0911a857136..403965637ce 100644 --- a/htdocs/includes/modules/propale/mod_propale_ivoire.php +++ b/htdocs/includes/modules/propale/mod_propale_ivoire.php @@ -1,5 +1,6 @@ + * Copyright (C) 2004 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 @@ -22,32 +23,43 @@ */ -/*! \file htdocs/includes/modules/propale/mod_propale_ivoire.php +/** \file htdocs/includes/modules/propale/mod_propale_ivoire.php \ingroup propale \brief Fichier contenant la classe du modèle de numérotation de référence de propale Ivoire \version $Revision$ */ -/*! \class mod_propale_ivoire +/** \class mod_propale_ivoire \brief Classe du modèle de numérotation de référence de propale Ivoire */ class mod_propale_ivoire extends ModeleNumRefPropales { - /*! \brief Renvoi la description du modele de numérotation + + /** \brief Renvoi la description du modele de numérotation * \return string Texte descripif */ - function info() + function info() { - return "Renvoie le numéro sous la forme PR040001"; + return "Renvoie le numéro sous la forme PRyynnnn où yy est l'année et nnnn un compteur sans remise à 0"; } - /*! \brief Renvoie la référence de propale suivante non utilisée + + /** \brief Renvoi un exemple de numérotation + * \return string Example + */ + function getExample() + { + return "PR040001"; + } + + + /** \brief Renvoie la référence de propale suivante non utilisée * \param objsoc Objet société * \return string Texte descripif */ - function propale_get_num($objsoc=0) + function propale_get_num($objsoc=0) { global $db; diff --git a/htdocs/includes/modules/propale/mod_propale_jade.php b/htdocs/includes/modules/propale/mod_propale_jade.php index e71d2b4ad32..5381967e649 100644 --- a/htdocs/includes/modules/propale/mod_propale_jade.php +++ b/htdocs/includes/modules/propale/mod_propale_jade.php @@ -1,5 +1,6 @@ + * Copyright (C) 2004 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,32 +22,43 @@ * */ -/*! \file htdocs/includes/modules/propale/mod_propale_jade.php +/** \file htdocs/includes/modules/propale/mod_propale_jade.php \ingroup propale \brief Fichier contenant la classe du modèle de numérotation de référence de propale Jade \version $Revision$ */ -/*! \class mod_propale_jade +/** \class mod_propale_jade \brief Classe du modèle de numérotation de référence de propale Jade */ class mod_propale_jade extends ModeleNumRefPropales { - /*! \brief Renvoi la description du modele de numérotation + + /** \brief Renvoi la description du modele de numérotation * \return string Texte descripif */ - function info() + function info() { - return "Renvoie le numéro sous la forme PROP1, PROP2, ..."; + return "Renvoie le numéro sous la forme PROPn"; } - /*! \brief Renvoie la référence de propale suivante non utilisée + + /** \brief Renvoi un exemple de numérotation + * \return string Example + */ + function getExample() + { + return "PROP1"; + } + + + /** \brief Renvoie la référence de propale suivante non utilisée * \param objsoc Objet société * \return string Texte descripif */ - function propale_get_num($objsoc=0) + function propale_get_num($objsoc=0) { global $db;