Wavyzz/dolibarr
2
0
Fork 1
mirror of https://github.com/Dolibarr/dolibarr.git synced 2025-12-06 09:38:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Mise a jour pour doxygen

Browse Source
This commit is contained in:
Laurent Destailleur
2008-01-20 18:47:10 +00:00
parent 7ab69e52af
commit acd972fc94
10 changed files with 97 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
dev/skeletons/skeleton_class.class.php
View File

@@ -15,14 +15,14 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id$
*/ */
/** /**
\file dev/skeletons/skeleton_class.class.php \file dev/skeletons/skeleton_class.class.php
\ingroup unknown \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 \remarks Put here some comments
*/ */
@@ -35,6 +35,7 @@
/** /**
\class Skeleton_class \class Skeleton_class
\brief Put here description of your class \brief Put here description of your class
\remarks Put here some comments
*/ */
class Skeleton_class // extends CommonObject class Skeleton_class // extends CommonObject
{ {

11
dev/skeletons/skeleton_page.php
View File

@@ -1,5 +1,6 @@
<?php <?php
/* Copyright (C) 2007 Laurent Destailleur <eldy@users.sourceforge.net> /* Copyright (C) 2007 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) ---Put here your own copyright and developer email---
* *
* 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
@@ -14,15 +15,15 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id$
*/ */
/** /**
\file dev/skeletons/skeleton_page.php \file dev/skeletons/skeleton_page.php
\ingroup core \ingroup unknown
\brief Example of a php page \brief This file is an example of a php page
\version $Revision$ \version $Id$
\author Put author name here
\remarks Put here some comments
*/ */
require("./pre.inc.php"); require("./pre.inc.php");

11
dev/skeletons/skeleton_script.php
View File

@@ -1,5 +1,6 @@
<?PHP <?PHP
/* Copyright (C) 2007 Laurent Destailleur <eldy@users.sourceforge.net> /* Copyright (C) 2007 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) ---Put here your own copyright and developer email---
* *
* 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
@@ -14,15 +15,15 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id$
*/ */
/** /**
\file dev/skeletons/skeleton_script.php \file dev/skeletons/skeleton_script.php
\ingroup core \ingroup unknown
\brief Example for scripts \brief This file is an example for a command line script
\version $Revision$ \version $Id$
\author Put author name here
\remarks Put here some comments
*/ */
// Test if batch mode // Test if batch mode

37
doc/dev/dolibarr-doxygen.conf
View File

@@ -8,7 +8,7 @@
# Project related configuration options # Project related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
PROJECT_NAME = dolibarr PROJECT_NAME = dolibarr
PROJECT_NUMBER = 2.2.0 PROJECT_NUMBER = 2.4.0
OUTPUT_DIRECTORY = doc/dev OUTPUT_DIRECTORY = doc/dev
CREATE_SUBDIRS = NO CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
@@ -22,10 +22,11 @@ FULL_PATH_NAMES = YES
STRIP_FROM_PATH = STRIP_FROM_PATH =
STRIP_FROM_INC_PATH = STRIP_FROM_INC_PATH =
SHORT_NAMES = NO SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = YES DETAILS_AT_TOP = YES
INHERIT_DOCS = YES INHERIT_DOCS = YES
CPP_CLI_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO DISTRIBUTE_GROUP_DOC = NO
TAB_SIZE = 2 TAB_SIZE = 2
ALIASES = ALIASES =
@@ -38,7 +39,7 @@ SUBGROUPING = YES
EXTRACT_ALL = NO EXTRACT_ALL = NO
EXTRACT_PRIVATE = YES EXTRACT_PRIVATE = YES
EXTRACT_STATIC = NO EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_METHODS = NO EXTRACT_LOCAL_METHODS = NO
HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = NO HIDE_UNDOC_CLASSES = NO
@@ -59,30 +60,33 @@ GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS = ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30 MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES SHOW_USED_FILES = YES
SHOW_DIRECTORIES = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to warning and progress messages # configuration options related to warning and progress messages
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
QUIET = NO QUIET = NO
WARNINGS = YES WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES WARN_IF_UNDOCUMENTED = NO
WARN_IF_DOC_ERROR = YES WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text" WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = WARN_LOGFILE = doxygen_warnings.log
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the input files # configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = htdocs INPUT = htdocs
FILE_PATTERNS = *.php FILE_PATTERNS = *.php
RECURSIVE = YES RECURSIVE = YES
EXCLUDE = mysql \ EXCLUDE = mssql \
mysql \
pgsql \ pgsql \
CVS \ CVS \
build \ build \
doc \ dev \
doc \
documents \ documents \
external-libs \ external-libs \
htdocs/conf/conf.php \ htdocs/conf/conf.php \
htdocs/domain \
htdocs/includes/adodbtime \ htdocs/includes/adodbtime \
htdocs/includes/barcode \ htdocs/includes/barcode \
htdocs/includes/cryptograph \ htdocs/includes/cryptograph \
@@ -110,13 +114,16 @@ EXCLUDE = mysql \
htdocs/voyage \ htdocs/voyage \
htdocs/oscommerce_ws/ws_client_demo \ htdocs/oscommerce_ws/ws_client_demo \
htdocs/oscommerce_ws/ws_server \ htdocs/oscommerce_ws/ws_server \
scripts/lolix scripts/addons \
EXCLUDE_SYMLINKS = NO scripts/courrier \
EXCLUDE_PATTERNS = */CVS/Base/* scripts/lolix
scripts/energie
EXCLUDE_SYMLINKS = YES
EXCLUDE_PATTERNS = */CVS/*
EXAMPLE_PATH = EXAMPLE_PATH =
EXAMPLE_PATTERNS = EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO EXAMPLE_RECURSIVE = NO
IMAGE_PATH = IMAGE_PATH = doc/images
INPUT_FILTER = INPUT_FILTER =
FILTER_PATTERNS = FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO FILTER_SOURCE_FILES = NO
@@ -155,6 +162,7 @@ DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4 ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250 TREEVIEW_WIDTH = 250
HTML_DYNAMIC_SECTIONS = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the LaTeX output # configuration options related to the LaTeX output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
@@ -233,11 +241,14 @@ HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES HAVE_DOT = YES
CLASS_GRAPH = YES CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES COLLABORATION_GRAPH = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES INCLUDED_BY_GRAPH = YES
# CALL_GRAPH and CALLER_GRAPH and GROUP_GRAPH and UML_LOOK increase time of run
CALL_GRAPH = NO CALL_GRAPH = NO
CALLER_GRAPH = NO
GROUP_GRAPHS = NO
UML_LOOK = NO
GRAPHICAL_HIERARCHY = YES GRAPHICAL_HIERARCHY = YES
DOT_IMAGE_FORMAT = png DOT_IMAGE_FORMAT = png
DOT_PATH = DOT_PATH =

9
htdocs/includes/modules/modDroitPret.class.php
View File

@@ -14,13 +14,12 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id$
*/ */
/** /**
\defgroup DroitPret Module pr<EFBFBD>t \defgroup DroitPret Module pret
\brief Module pour g<>rer le suivi des droits de pr<70>ts \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 * \brief Constructeur. Definit les noms, constantes et boites
* \param DB handler d'acc<EFBFBD>s base * \param DB handler d'acces base
*/ */
function modDroitPret($DB) function modDroitPret($DB)
{ {

9
htdocs/includes/modules/modLabel.class.php
View File

@@ -14,13 +14,12 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Id$
*/ */
/** /**
\defgroup label Module <EFBFBD>tiquettes \defgroup label Module Etiquettes
\brief Module pour g<>rer l'impression des <20>tiquettes \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 * \brief Constructeur. Definit les noms, constantes et boites
* \param DB handler d'acc<EFBFBD>s base * \param DB handler d'acces base
*/ */
function modLabel($DB) function modLabel($DB)
{ {

29
htdocs/lib/CMailFile.class.php
View File

@@ -18,31 +18,26 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* or see http://www.gnu.org/ * or see http://www.gnu.org/
* *
* $Id$
*
* Lots of code inspired from Dan Potter's CMailFile class * 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 * If chunk_split does not works on your system, change the call to chunk_split
* to _chunk_split * to _chunk_split
*/ */
/** /**
\file htdocs/lib/CMailFile.class.php * \file htdocs/lib/CMailFile.class.php
\brief Classe permettant d'envoyer des mail avec attachements * \brief Fichier de la classe permettant d'envoyer des mail avec attachements
\author Dan Potter. * \version $Id$
\author Eric Seigne * \author Dan Potter.
\author Laurent Destailleur. * \author Eric Seigne
\version $Revision$ * \author Laurent Destailleur.
*/ */
/** /**
\class CMailFile * \class CMailFile
\brief Classe d'envoi de mails et pi<EFBFBD>ces jointes. Encapsule mail() avec d'<EFBFBD>ventuel attachements. * \brief Classe d'envoi de mails et pieces jointes. Encapsule mail() avec d'eventuels attachements.
\remarks Usage: * \remarks Usage: $mailfile = new CMailFile($subject,$sendto,$replyto,$message,$filepath,$mimetype,$filename,$cc,$ccc);
\remarks $mailfile = new CMailFile($subject,$sendto,$replyto,$message,$filepath,$mimetype,$filename,$cc,$ccc); * \remarks $mailfile->sendfile();
\remarks $mailfile->sendfile();
*/ */
class CMailFile class CMailFile
{ {
var $subject; var $subject;
@@ -418,7 +413,7 @@ class CMailFile
/** /**
\brief Renvoie une adresse accept<EFBFBD>e par le serveur SMTP \brief Renvoie une adresse acceptee par le serveur SMTP
\param adresses Exemple: 'John Doe <john@doe.com>' ou 'john@doe.com' \param adresses Exemple: 'John Doe <john@doe.com>' ou 'john@doe.com'
\param format 0=Auto, 1=emails avec <>, 2=emails sans <> \param format 0=Auto, 1=emails avec <>, 2=emails sans <>
\return string Renvoi: Si format 1: '<john@doe.com>' ou 'John Doe <john@doe.com>' \return string Renvoi: Si format 1: '<john@doe.com>' ou 'John Doe <john@doe.com>'
@@ -428,7 +423,7 @@ function getValidAddress($adresses,$format)
{ {
global $conf; global $conf;
$ret=""; $ret='';
$arrayaddress=split(',',$adresses); $arrayaddress=split(',',$adresses);

27
htdocs/lib/doxygen.php Normal file
View File

@@ -0,0 +1,27 @@
<?php
/* Copyright (C) 2008 Laurent Destailleur <eldy@users.sourceforge.net>
*
* 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.<br>
* This documentation can be built or updated running the script <b>dolibarr-doxygen-build.pl</b><br>
* <br>
* Dolibarr official web site: <a href="http://dolibarr.org">dolibarr.org</a><br>
*/

8
htdocs/main.inc.php
View File

@@ -215,7 +215,7 @@ else
// Remarks: On ne sauvegarde pas objet user car pose pb dans certains cas mal identifies // Remarks: On ne sauvegarde pas objet user car pose pb dans certains cas mal identifies
$login=$_SESSION["dol_login"]; $login=$_SESSION["dol_login"];
$resultFetchUser=$user->fetch($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) if ($resultFetchUser <= 0)
{ {
// Account has been removed after login // Account has been removed after login
@@ -288,11 +288,11 @@ if ($user->admin)
* Overwrite configs global par configs perso * 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; $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; $conf->produit->limit_size = $user->conf->PRODUIT_LIMIT_SIZE;
} }
@@ -384,7 +384,7 @@ if ($user->statut < 1)
{ {
// Si non actif, on delogue le user // Si non actif, on delogue le user
$langs->load("other"); $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")); accessforbidden($langs->trans("ErrorLoginDisabled"));
exit; exit;
} }

13
htdocs/usergroup.class.php
View File

@@ -17,7 +17,6 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* *
* $Id$ * $Id$
* $Source$
*/ */
/** /**
@@ -37,13 +36,13 @@ if ($conf->ldap->enabled) require_once (DOL_DOCUMENT_ROOT."/lib/ldap.class.php")
class UserGroup class UserGroup
{ {
var $db; var $db; // Database handler
var $id; var $id; // Group id
var $nom; var $nom; // Name of group
var $note; var $note; // Note on group
var $datec; var $datec; // Creation date of group
var $datem; var $datem; // Modification date of group
/** /**