diff --git a/dev/skeletons/skeleton_class.class.php b/dev/skeletons/skeleton_class.class.php index 85f7e717dbb..f44c6d40586 100644 --- a/dev/skeletons/skeleton_class.class.php +++ b/dev/skeletons/skeleton_class.class.php @@ -15,14 +15,14 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * $Id$ */ /** \file dev/skeletons/skeleton_class.class.php \ingroup unknown - \brief This file is an example to create a new class file + \brief This file is an example for a class file + \version $Id$ + \author Put author name here \remarks Put here some comments */ @@ -35,6 +35,7 @@ /** \class Skeleton_class \brief Put here description of your class + \remarks Put here some comments */ class Skeleton_class // extends CommonObject { diff --git a/dev/skeletons/skeleton_page.php b/dev/skeletons/skeleton_page.php index 4afdec25846..c2fa08c9596 100644 --- a/dev/skeletons/skeleton_page.php +++ b/dev/skeletons/skeleton_page.php @@ -1,5 +1,6 @@ + * Copyright (C) ---Put here your own copyright and developer email--- * * 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 @@ -14,15 +15,15 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * $Id$ */ /** \file dev/skeletons/skeleton_page.php - \ingroup core - \brief Example of a php page - \version $Revision$ + \ingroup unknown + \brief This file is an example of a php page + \version $Id$ + \author Put author name here + \remarks Put here some comments */ require("./pre.inc.php"); diff --git a/dev/skeletons/skeleton_script.php b/dev/skeletons/skeleton_script.php index 7d7de599198..a1bc46d7605 100644 --- a/dev/skeletons/skeleton_script.php +++ b/dev/skeletons/skeleton_script.php @@ -1,5 +1,6 @@ + * Copyright (C) ---Put here your own copyright and developer email--- * * 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 @@ -14,15 +15,15 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * $Id$ */ /** \file dev/skeletons/skeleton_script.php - \ingroup core - \brief Example for scripts - \version $Revision$ + \ingroup unknown + \brief This file is an example for a command line script + \version $Id$ + \author Put author name here + \remarks Put here some comments */ // Test if batch mode diff --git a/doc/dev/dolibarr-doxygen.conf b/doc/dev/dolibarr-doxygen.conf index 7b199753168..f57bd8d9110 100644 --- a/doc/dev/dolibarr-doxygen.conf +++ b/doc/dev/dolibarr-doxygen.conf @@ -8,7 +8,7 @@ # Project related configuration options #--------------------------------------------------------------------------- PROJECT_NAME = dolibarr -PROJECT_NUMBER = 2.2.0 +PROJECT_NUMBER = 2.4.0 OUTPUT_DIRECTORY = doc/dev CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English @@ -22,10 +22,11 @@ FULL_PATH_NAMES = YES STRIP_FROM_PATH = STRIP_FROM_INC_PATH = SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES MULTILINE_CPP_IS_BRIEF = NO DETAILS_AT_TOP = YES INHERIT_DOCS = YES +CPP_CLI_SUPPORT = NO DISTRIBUTE_GROUP_DOC = NO TAB_SIZE = 2 ALIASES = @@ -38,7 +39,7 @@ SUBGROUPING = YES EXTRACT_ALL = NO EXTRACT_PRIVATE = YES EXTRACT_STATIC = NO -EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = NO @@ -59,30 +60,33 @@ GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES +SHOW_DIRECTORIES = YES #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- QUIET = NO WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = YES WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = +WARN_LOGFILE = doxygen_warnings.log #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = htdocs FILE_PATTERNS = *.php RECURSIVE = YES -EXCLUDE = mysql \ +EXCLUDE = mssql \ + mysql \ pgsql \ CVS \ build \ - doc \ + dev \ + doc \ documents \ external-libs \ htdocs/conf/conf.php \ - htdocs/domain \ htdocs/includes/adodbtime \ htdocs/includes/barcode \ htdocs/includes/cryptograph \ @@ -110,13 +114,16 @@ EXCLUDE = mysql \ htdocs/voyage \ htdocs/oscommerce_ws/ws_client_demo \ htdocs/oscommerce_ws/ws_server \ - scripts/lolix -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = */CVS/Base/* + scripts/addons \ + scripts/courrier \ + scripts/lolix + scripts/energie +EXCLUDE_SYMLINKS = YES +EXCLUDE_PATTERNS = */CVS/* EXAMPLE_PATH = EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO -IMAGE_PATH = +IMAGE_PATH = doc/images INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO @@ -155,6 +162,7 @@ DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = NO TREEVIEW_WIDTH = 250 +HTML_DYNAMIC_SECTIONS = YES #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -233,11 +241,14 @@ HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES CLASS_GRAPH = YES COLLABORATION_GRAPH = YES -UML_LOOK = NO TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES +# CALL_GRAPH and CALLER_GRAPH and GROUP_GRAPH and UML_LOOK increase time of run CALL_GRAPH = NO +CALLER_GRAPH = NO +GROUP_GRAPHS = NO +UML_LOOK = NO GRAPHICAL_HIERARCHY = YES DOT_IMAGE_FORMAT = png DOT_PATH = diff --git a/htdocs/includes/modules/modDroitPret.class.php b/htdocs/includes/modules/modDroitPret.class.php index 2b9b1d6db31..c3da9175588 100644 --- a/htdocs/includes/modules/modDroitPret.class.php +++ b/htdocs/includes/modules/modDroitPret.class.php @@ -14,13 +14,12 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * $Id$ */ /** - \defgroup DroitPret Module pr�t - \brief Module pour g�rer le suivi des droits de pr�ts + \defgroup DroitPret Module pret + \version $Id$ + \brief Module pour gerer le suivi des droits de prets */ /** @@ -42,7 +41,7 @@ class modDroitPret extends DolibarrModules /** * \brief Constructeur. Definit les noms, constantes et boites - * \param DB handler d'acc�s base + * \param DB handler d'acces base */ function modDroitPret($DB) { diff --git a/htdocs/includes/modules/modLabel.class.php b/htdocs/includes/modules/modLabel.class.php index 79fa881aeca..efefa14da9b 100644 --- a/htdocs/includes/modules/modLabel.class.php +++ b/htdocs/includes/modules/modLabel.class.php @@ -14,13 +14,12 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * $Id$ */ /** - \defgroup label Module �tiquettes - \brief Module pour g�rer l'impression des �tiquettes + \defgroup label Module Etiquettes + \version $Id$ + \brief Module pour gerer les formats d'impression des etiquettes */ /** @@ -42,7 +41,7 @@ class modLabel extends DolibarrModules /** * \brief Constructeur. Definit les noms, constantes et boites - * \param DB handler d'acc�s base + * \param DB handler d'acces base */ function modLabel($DB) { diff --git a/htdocs/lib/CMailFile.class.php b/htdocs/lib/CMailFile.class.php index 5897bda5ad5..7550f347822 100644 --- a/htdocs/lib/CMailFile.class.php +++ b/htdocs/lib/CMailFile.class.php @@ -18,31 +18,26 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * or see http://www.gnu.org/ * - * $Id$ - * * Lots of code inspired from Dan Potter's CMailFile class - * * If chunk_split does not works on your system, change the call to chunk_split * to _chunk_split */ /** - \file htdocs/lib/CMailFile.class.php - \brief Classe permettant d'envoyer des mail avec attachements - \author Dan Potter. - \author Eric Seigne - \author Laurent Destailleur. - \version $Revision$ +* \file htdocs/lib/CMailFile.class.php +* \brief Fichier de la classe permettant d'envoyer des mail avec attachements +* \version $Id$ +* \author Dan Potter. +* \author Eric Seigne +* \author Laurent Destailleur. */ /** - \class CMailFile - \brief Classe d'envoi de mails et pi�ces jointes. Encapsule mail() avec d'�ventuel attachements. - \remarks Usage: - \remarks $mailfile = new CMailFile($subject,$sendto,$replyto,$message,$filepath,$mimetype,$filename,$cc,$ccc); - \remarks $mailfile->sendfile(); +* \class CMailFile +* \brief Classe d'envoi de mails et pieces jointes. Encapsule mail() avec d'eventuels attachements. +* \remarks Usage: $mailfile = new CMailFile($subject,$sendto,$replyto,$message,$filepath,$mimetype,$filename,$cc,$ccc); +* \remarks $mailfile->sendfile(); */ - class CMailFile { var $subject; @@ -418,7 +413,7 @@ class CMailFile /** - \brief Renvoie une adresse accept�e par le serveur SMTP + \brief Renvoie une adresse acceptee par le serveur SMTP \param adresses Exemple: 'John Doe ' ou 'john@doe.com' \param format 0=Auto, 1=emails avec <>, 2=emails sans <> \return string Renvoi: Si format 1: '' ou 'John Doe ' @@ -428,7 +423,7 @@ function getValidAddress($adresses,$format) { global $conf; - $ret=""; + $ret=''; $arrayaddress=split(',',$adresses); diff --git a/htdocs/lib/doxygen.php b/htdocs/lib/doxygen.php new file mode 100644 index 00000000000..04e71cd5cd7 --- /dev/null +++ b/htdocs/lib/doxygen.php @@ -0,0 +1,27 @@ + + * + * 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 + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * or see http://www.gnu.org/ + */ + +/** +* \mainpage Dolibarr project +* +* This is source documentation for Dolibarr.
+* This documentation can be built or updated running the script dolibarr-doxygen-build.pl
+*
+* Dolibarr official web site: dolibarr.org
+*/ \ No newline at end of file diff --git a/htdocs/main.inc.php b/htdocs/main.inc.php index 3f981d4ac82..acab84d91b6 100644 --- a/htdocs/main.inc.php +++ b/htdocs/main.inc.php @@ -215,7 +215,7 @@ else // Remarks: On ne sauvegarde pas objet user car pose pb dans certains cas mal identifies $login=$_SESSION["dol_login"]; $resultFetchUser=$user->fetch($login); - dolibarr_syslog("This is an already user logged session. _SESSION['dol_login']=".$login); + dolibarr_syslog("This is an already logged session. _SESSION['dol_login']=".$login); if ($resultFetchUser <= 0) { // Account has been removed after login @@ -288,11 +288,11 @@ if ($user->admin) * Overwrite configs global par configs perso * ------------------------------------------ */ -if (isset($user->conf->MAIN_SIZE_LISTE_LIMIT) && $user->conf->MAIN_SIZE_LISTE_LIMIT > 0) +if (isset($user->conf->MAIN_SIZE_LISTE_LIMIT)) // Can be 0 { $conf->liste_limit = $user->conf->MAIN_SIZE_LISTE_LIMIT; } -if (isset($user->conf->PRODUIT_LIMIT_SIZE)) +if (isset($user->conf->PRODUIT_LIMIT_SIZE)) // Can be 0 { $conf->produit->limit_size = $user->conf->PRODUIT_LIMIT_SIZE; } @@ -384,7 +384,7 @@ if ($user->statut < 1) { // Si non actif, on delogue le user $langs->load("other"); - dolibarr_syslog ("Authentification ko (en mode Pear Base Dolibarr) car login desactive"); + dolibarr_syslog ("Authentification ko car login desactive"); accessforbidden($langs->trans("ErrorLoginDisabled")); exit; } diff --git a/htdocs/usergroup.class.php b/htdocs/usergroup.class.php index 16c5e538116..2c5f2645366 100644 --- a/htdocs/usergroup.class.php +++ b/htdocs/usergroup.class.php @@ -17,7 +17,6 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * $Id$ - * $Source$ */ /** @@ -37,13 +36,13 @@ if ($conf->ldap->enabled) require_once (DOL_DOCUMENT_ROOT."/lib/ldap.class.php") class UserGroup { - var $db; + var $db; // Database handler - var $id; - var $nom; - var $note; - var $datec; - var $datem; + var $id; // Group id + var $nom; // Name of group + var $note; // Note on group + var $datec; // Creation date of group + var $datem; // Modification date of group /**