Doc: Mise a jour documentation doxygen

This commit is contained in:
Laurent Destailleur 2005-04-20 22:02:54 +00:00
parent dae88ffd44
commit 012d8cc006

View File

@ -1,7 +1,7 @@
<?php <?php
/* Copyright (C) 2000-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org> /* Copyright (C) 2000-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2003 Jean-Louis Bergamo <jlb@j1b.org> * Copyright (C) 2003 Jean-Louis Bergamo <jlb@j1b.org>
* Copyright (C) 2004 Laurent Destailleur <eldy@users.sourceforge.net> * Copyright (C) 2004-2005 Laurent Destailleur <eldy@users.sourceforge.net>
* *
* This program is free software; you can redistribute it and/or modify * 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 * it under the terms of the GNU General Public License as published by
@ -24,20 +24,20 @@
* Lots of code inspired from Dan Potter's CMailFile class * Lots of code inspired from Dan Potter's CMailFile class
*/ */
/*! /**
\file htdocs/lib/dolibarrmail.class.php \file htdocs/lib/dolibarrmail.class.php
\brief Classe permettant d'envoyer des mail avec attachements, recriture de CMailFile \brief Classe permettant d'envoyer des mail avec attachements, reecriture de CMailFile
\author Dan Potter. \author Dan Potter.
\author Eric Seigne \author Eric Seigne
\author Rodolphe Quiedeville \author Rodolphe Quiedeville
\author Laurent Destailleur. \author Laurent Destailleur.
\version $Revision$ \version $Revision$
*/ */
/*! /**
\class DolibarrMail \class DolibarrMail
\brief Classe permettant d'envoyer des attachements par mail \brief Classe permettant d'envoyer des attachements par mail
\todo Classe en double avec CMAilFile.class.php \todo Classe en double avec CMailFile.class.php
*/ */
class DolibarrMail class DolibarrMail
@ -139,8 +139,8 @@ class DolibarrMail
} }
/** /**
\brief permet d'encoder un fichier \brief Permet d'encoder un fichier
\param sourcefile \param sourcefile
*/ */
function encode_file($sourcefile) function encode_file($sourcefile)
@ -160,7 +160,8 @@ class DolibarrMail
} }
/** /**
\brief envoi le mail \brief Envoi le mail
\return boolean vrai si mail envoyé, faux sinon
*/ */
function sendfile() function sendfile()
@ -186,9 +187,10 @@ class DolibarrMail
return $res; return $res;
} }
/** /**
* Ecrit le mail dans un fichier * \brief Ecrit le mail dans un fichier
* Utilisation pour le debuggage * Utilisation pour le debuggage
*/ */
function write_to_file() function write_to_file()
{ {
@ -206,7 +208,7 @@ class DolibarrMail
} }
/** /**
\brief permet d'ecrire le corps du message \brief Permet d'ecrire le corps du message
*/ */
function write_body() function write_body()