Doc: Documentation doxygen

This commit is contained in:
Laurent Destailleur 2004-12-31 17:29:28 +00:00
parent 45672460d1
commit 6369688c54

View File

@ -24,15 +24,17 @@
* *
*/ */
/*! \file htdocs/societe.class.php /**
\file htdocs/societe.class.php
\ingroup societe \ingroup societe
\brief Fichier de la classe des societes \brief Fichier de la classe des societes
\version $Revision$ \version $Revision$
*/ */
/*! \class Societe /**
\brief Classe permettant la gestion des societes \class Societe
\brief Classe permettant la gestion des societes
*/ */
class Societe { class Societe {
@ -134,6 +136,7 @@ class Societe {
/** /**
* \brief Verification lors de la modification * \brief Verification lors de la modification
*/ */
function verify() function verify()
{ {
$result = 0; $result = 0;
@ -442,8 +445,8 @@ class Societe {
} }
/** /**
* \brief Suppression d'une societe de la base * \brief Suppression d'une societe de la base
* \todo Cette fonction n'est pas utilisée. Attente des contraintes d'intégrité dans MySql * \todo Cette fonction n'est pas utilisée. Attente des contraintes d'intégrité dans MySql
*/ */
function delete($id) function delete($id)
@ -498,7 +501,7 @@ class Societe {
$this->db->query("COMMIT"); $this->db->query("COMMIT");
// Suppression du répertoire document // Suppression du répertoire document
$docdir = SOCIETE_OUTPUTDIR . "/$id"; $docdir = $conf->societe->dir_output . "/" . $id;
if (file_exists ($docdir)) if (file_exists ($docdir))
{ {
@ -515,10 +518,13 @@ class Societe {
} }
} }
/*
* Cette fonction permet de supprimer le répertoire de la societe /**
* Meme s'il contient des documents. * \brief Cette fonction permet de supprimer le répertoire de la societe
* et sous répertoire, meme s'ils contiennent des documents.
* \param dir repertoire a supprimer
*/ */
function deldir($dir) function deldir($dir)
{ {
$current_dir = opendir($dir); $current_dir = opendir($dir);
@ -539,10 +545,11 @@ class Societe {
} }
/** /**
* \brief Retournes les factures impayées de la société * \brief Retournes les factures impayées de la société
* \return array tableau des id de factures impayées * \return array tableau des id de factures impayées
* *
*/ */
function factures_impayes() function factures_impayes()
{ {
$facimp = array(); $facimp = array();
@ -968,6 +975,7 @@ class Societe {
return $rib; return $rib;
} }
function rib() function rib()
{ {
require_once DOL_DOCUMENT_ROOT . "/companybankaccount.class.php"; require_once DOL_DOCUMENT_ROOT . "/companybankaccount.class.php";
@ -980,15 +988,18 @@ class Societe {
return 1; return 1;
} }
function verif_rib() function verif_rib()
{ {
$this->rib(); $this->rib();
return $this->bank_account->verif(); return $this->bank_account->verif();
} }
/** /**
* Renvoie 0 si ok, peut modifier le code client suivant le module utilisé * \brief Verifie code client
* * \return Renvoie 0 si ok, peut modifier le code client suivant le module utilisé
*/ */
function verif_codeclient() function verif_codeclient()
{ {
if (defined('CODECLIENT_ADDON') && strlen(CODECLIENT_ADDON) > 0) if (defined('CODECLIENT_ADDON') && strlen(CODECLIENT_ADDON) > 0)
@ -1026,11 +1037,12 @@ class Societe {
return 0; return 0;
} }
} }
/** /**
* Renvoie un code compta, suivant le module le code compta renvoyé * \brief Renvoie un code compta, suivant le module le code compta renvoyé
* peut être identique à celui saisit ou généré automatiquement * peut être identique à celui saisit ou généré automatiquement
* *
* A ce jour seul la génération automatique est implémentée * A ce jour seul la génération automatique est implémentée
*/ */
function check_codecompta() function check_codecompta()
{ {
@ -1054,6 +1066,7 @@ class Societe {
return 0; return 0;
} }
} }
} }
?> ?>