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

Fix: Doxygen documentation

Browse Source 
Removed deprecated files
This commit is contained in:
Laurent Destailleur
2010-07-21 11:21:37 +00:00
parent 4a01bd5188
commit d46ed0c984
11 changed files with 179 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
build/dolibarr-doxygen-build.pl
View File

@@ -13,21 +13,21 @@ $DIR =~ s/([^\/\\])[\\\/]+$/$1/;
$OPTIONS=""; $OPTIONS="";
#$OPTIONS="-d Preprocessor"; #$OPTIONS="-d Preprocessor";
$CONFFILE="doxygen/dolibarr-doxygen.doxyfile"; $CONFFILE="dolibarr-doxygen.doxyfile";
use Cwd; use Cwd;
my $dir = getcwd; my $dir = getcwd;
print "Current dir is: $dir\n"; print "Current dir is: $dir\n";
print "Running dir for doxygen must be: $DIR\n"; print "Running dir for doxygen must be: $DIR/doxygen\n";
if (! -s $CONFFILE) if (! -s $CONFFILE)
{ {
print "Error: current directory for building Dolibarr doxygen documentation is not correct.\n"; print "Error: current directory for building Dolibarr doxygen documentation is not correct.\n";
print "\n"; print "\n";
print "Change your current directory then, to launch the script, run:\n"; print "Change your current directory then, to launch the script, run:\n";
print '> perl dolibarr-doxygen-build.pl (on Windows)'."\n"; print '> perl ..\dolibarr-doxygen-build.pl (on Windows)'."\n";
print '> perl dolibarr-doxygen-build.pl (on Linux or BSD)'."\n"; print '> perl ../dolibarr-doxygen-build.pl (on Linux or BSD)'."\n";
sleep 4; sleep 4;
exit 1; exit 1;
} }

17
build/doxygen/dolibarr-doxygen.doxyfile
View File

@@ -38,7 +38,7 @@ PROJECT_NUMBER = 2.9.0
# If a relative path is entered, it will be relative to the location # If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = ../build OUTPUT_DIRECTORY = ../../build
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output # 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -513,7 +513,7 @@ WARN_LOGFILE = doxygen_warnings.log
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = ../htdocs ../scripts INPUT = ../../htdocs ../../scripts
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -521,8 +521,7 @@ INPUT = ../htdocs ../scripts
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings. # the list of possible encodings.
#INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
INPUT_ENCODING = ISO-8859-1
# If the value of the INPUT tag contains directories, you can use the # If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -543,7 +542,7 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a # excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag. # subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = ../mssql ../mysql ../pgsql ../CVS ../build ../dev ../doc ../documents ../htdocs/conf/conf.php ../htdocs/includes/adodbtime ../htdocs/includes/artichow ../htdocs/includes/efc_xfss ../htdocs/includes/barcode ../htdocs/includes/fckeditor ../htdocs/includes/fpdf ../htdocs/includes/geoip ../htdocs/includes/magpierss ../htdocs/includes/nusoap ../htdocs/includes/odtphp ../htdocs/includes/pear ../htdocs/includes/php_excelreader ../htdocs/includes/php_writeexcel ../htdocs/includes/phplot ../htdocs/includes/phplot5 ../htdocs/includes/pwc ../htdocs/includes/scriptaculous ../htdocs/includes/simplemail ../htdocs/includes/smarty ../htdocs/includes/smtps ../htdocs/includes/vcard ../htdocs/avoir ../htdocs/document ../htdocs/documents ../htdocs/lolix ../htdocs/postnuke ../htdocs/rapport ../htdocs/telephonie ../htdocs/voyage ../htdocs/oscommerce_ws/ws_client_demo ../htdocs/oscommerce_ws/ws_server ../scripts/addons ../scripts/courrier ../scripts/lolix ../scripts/energie EXCLUDE = ../../mssql ../../mysql ../../pgsql ../../CVS ../../build ../../dev ../../doc ../../documents ../../htdocs/conf/conf.php ../../htdocs/includes/adodbtime ../../htdocs/includes/artichow ../../htdocs/includes/efc_xfss ../../htdocs/includes/barcode ../../htdocs/includes/fckeditor ../../htdocs/includes/fpdf ../../htdocs/includes/geoip ../../htdocs/includes/magpierss ../../htdocs/includes/nusoap ../../htdocs/includes/odtphp ../../htdocs/includes/pear ../../htdocs/includes/php_excelreader ../../htdocs/includes/php_writeexcel ../../htdocs/includes/phplot ../../htdocs/includes/phplot5 ../../htdocs/includes/pwc ../../htdocs/includes/scriptaculous ../../htdocs/includes/simplemail ../../htdocs/includes/smarty ../../htdocs/includes/smtps ../../htdocs/includes/vcard ../../htdocs/avoir ../../htdocs/document ../../htdocs/documents ../../htdocs/lolix ../../htdocs/postnuke ../../htdocs/rapport ../../htdocs/telephonie ../../htdocs/voyage ../../htdocs/oscommerce_ws/ws_client_demo ../../htdocs/oscommerce_ws/ws_server ../../scripts/addons ../../scripts/courrier ../../scripts/lolix ../../scripts/energie
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded # directories that are symbolic links (a Unix filesystem feature) are excluded
@@ -571,7 +570,7 @@ EXCLUDE_SYMBOLS =
# directories that contain example code fragments that are included (see # directories that contain example code fragments that are included (see
# the \include command). # the \include command).
EXAMPLE_PATH = ../dev/skeletons EXAMPLE_PATH = ../../dev/skeletons
# If the value of the EXAMPLE_PATH tag contains directories, you can use the # If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -591,7 +590,7 @@ EXAMPLE_RECURSIVE = NO
# directories that contain image that are included in the documentation (see # directories that contain image that are included in the documentation (see
# the \image command). # the \image command).
IMAGE_PATH = ../doc/images IMAGE_PATH = ../../doc/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should # The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -602,8 +601,8 @@ IMAGE_PATH = ../doc/images
# ignored. # ignored.
# Works on Linux only # Works on Linux only
#INPUT_FILTER = build/dolibarr-doxygen-filter.pl #INPUT_FILTER = ../dolibarr-doxygen-filter.pl
#INPUT_FILTER = "perl build/dolibarr-doxygen-filter.pl" #INPUT_FILTER = "perl ../dolibarr-doxygen-filter.pl"
INPUT_FILTER = INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern

5
htdocs/cashdesk/class/Auth.class.php
View File

@@ -17,7 +17,8 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/ */
class Auth {
class Auth {
protected $db; protected $db;
@@ -152,6 +153,6 @@
} }
} }
?> ?>

112
htdocs/cashdesk/class/Mysql.class.php
View File

@@ -1,112 +0,0 @@
<?php
/* Copyright (C) 2007-2008 Jeremie Ollivier <jeremie.o@laposte.net>
* Copyright (C) 2008 Laurent Destailleur <eldy@uers.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.
*/
require_once ('Sql.interface.php');
class Sql implements intSql {
/**
* Constructeur : initialise la connection <20> la base de donn<6E>es
* @param $aHost Domaine ou adresse IP du serveur de base de donn<6E>es (ex : localhost ou db.monsite.fr)
* @param $aUser Utilisateur de la base de donn<6E>es
* @param $aPass Mot de passe de l'utilisateur de la base de donn<6E>es
* @param $aBase Nom de la base de donn<6E>es <20> utiliser
*/
public function __construct ($aHost, $aUser, $aPass, $aBase) {
$db = mysql_connect ($aHost, $aUser, $aPass);
mysql_select_db ($aBase, $db);
}
/**
* Destructeur : ferme la connection <20> la base de donn<6E>es
*/
// D<>sactivation pour cause bug avec 1and1
// public function __destruct () {
//
// mysql_close ();
//
// }
/**
* Effectue une requete sur la base de donn<6E>es, et renvoi la ressource correspondante
* @param $aRequete Requete SQL (ex : SELECT nom, prenom FROM table1 WHERE id = 127)
* @return Ressource vers la requ<71>te venant d'<27>tre effectu<74>e
*/
public function query ($aRequete) {
dol_syslog("cashdesk query sql=".$aRequete, LOG_DEBUG);
return mysql_query($aRequete);
}
/**
* Renvoi le nombre de r<>sultats d'une requ<71>te
* @param $aRes Ressource d'une requ<71>te effectu<74>e pr<70>c<EFBFBD>demment
* @return Entier : nombre de r<>sultats de la requ<71>te
*/
public function num_rows ($aRes) {
return mysql_num_rows($aRes);
}
/**
* Enregistre tous les r<>sultats d'une requ<71>te dans un tableau <20> deux dimensions
* @param $aRes Ressource d'une requ<71>te effectu<74>e pr<70>c<EFBFBD>demment
* @return Tableau <20> deux dimensions : $tab[indice_resultat(integer)][indice_champ(integer) / nom_champ(string)]
*/
public function fetch_array ($aRes) {
$ret=array(); $i=0;
while ( $tab = mysql_fetch_array($aRes) )
{
foreach ( $tab as $cle => $valeur )
{
$ret[$i][$cle] = $valeur;
}
$i++;
}
return $ret;
}
/**
* Enregistre seulement le premier r<>sultat d'une requ<71>te dans un tableau <20> une dimension
* @param $aRes Ressource d'une requ<71>te effectu<74>e pr<70>c<EFBFBD>demment
* @return Tableau <20> une dimension : $tab[indice_champ(integer) / nom_champ(string)]
*/
public function fetchFirst ($aRes)
{
$ret=array();
$tab = mysql_fetch_array($aRes);
foreach ( $tab as $cle => $valeur )
{
$ret[$cle] = $valeur;
}
return $ret;
}
}
?>

37
htdocs/cashdesk/class/Sql.interface.php
View File

@@ -1,37 +0,0 @@
<?php
/* Copyright (C) 2007-2008 Jeremie Ollivier <jeremie.o@laposte.net>
* Copyright (C) 2008 Laurent Destailleur <eldy@uers.sourceforge.net>
* Copyright (C) 2009 Régis Houssin <regis@dolibarr.fr>
*
* 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.
*/
interface intSql {
// Envoie une requete et retourne le pointeur vers le resultat
public function query ($aRequete);
// Renvoie le nombre de resultats contenus dans la ressource
public function num_rows ($aRes);
// Parcours tous les resultats de la ressource et les enregistre dans un tableau a 2 dimensions : $tab[ligne][nom_champ/indice]
public function fetch_array ($aRes);
// Enregistre seulement le premier resultat de la ressource dans un tableau a 1 dimension : $tab[nom_champ/indice]
public function fetchFirst ($aRes);
}
?>

2
htdocs/categories/class/categorie.class.php
View File

@@ -22,7 +22,7 @@
*/ */
/** /**
* \file htdocs/categories/categorie.class.php * \file htdocs/categories/class/categorie.class.php
* \ingroup categorie * \ingroup categorie
* \brief Fichier de la classe des categorie * \brief Fichier de la classe des categorie
* \version $Id$ * \version $Id$

4
htdocs/compta/bank/class/bankcateg.class.php
View File

@@ -33,8 +33,8 @@
/** /**
* \class Bank_categ * \class BankCateg
* \brief Put here description of your class * \brief Class to manage bank categories
* \remarks Initialy built by build_class_from_table on 2009-01-02 15:26 * \remarks Initialy built by build_class_from_table on 2009-01-02 15:26
*/ */
class BankCateg // extends CommonObject class BankCateg // extends CommonObject

2
htdocs/compta/sociales/class/chargesociales.class.php
View File

@@ -18,7 +18,7 @@
*/ */
/** /**
* \file htdocs/chargesociales.class.php * \file htdocs/compta/sociales/class/chargesociales.class.php
* \ingroup facture * \ingroup facture
* \brief Fichier de la classe des charges sociales * \brief Fichier de la classe des charges sociales
* \version $Id$ * \version $Id$

12
htdocs/lib/bookmark.lib.php
View File

@@ -18,12 +18,12 @@
*/ */
/** /**
\file htdocs/lib/invoice.lib.php * \file htdocs/lib/bookmark.lib.php
\brief Ensemble de fonctions de base pour le module factures * \brief List of functions for bookmark module
\version $Id$ * \version $Id$
*
Ensemble de fonctions de base de dolibarr sous forme d'include * Ensemble de fonctions de base de dolibarr sous forme d'include
*/ */
function showArrayOfBookmark($fac) function showArrayOfBookmark($fac)
{ {

6
htdocs/lib/doxygen.php
View File

@@ -1,5 +1,5 @@
<?php <?php
/* Copyright (C) 2008-2009 Laurent Destailleur <eldy@users.sourceforge.net> /* Copyright (C) 2008-2010 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2009 Regis Houssin <regis@dolibarr.fr> * Copyright (C) 2009 Regis Houssin <regis@dolibarr.fr>
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@@ -21,8 +21,8 @@
/** /**
* \mainpage Dolibarr project * \mainpage Dolibarr project
* *
* This is source documentation for Dolibarr.<br> * This is source documentation for Dolibarr ERP/CRM.<br>
* This documentation can be built or updated running the script <b>dolibarr-doxygen-build.pl</b><br> * This documentation can be built or updated running the script <b>dolibarr-doxygen-build.pl</b> or from Eclipse with Doxygen plugin.<br>
* <br> * <br>
* Dolibarr official web site: <a href="http://www.dolibarr.org">www.dolibarr.org</a><br> * Dolibarr official web site: <a href="http://www.dolibarr.org">www.dolibarr.org</a><br>
* Dolibarr site francophone: <a href="http://www.dolibarr.fr">www.dolibarr.fr</a><br> * Dolibarr site francophone: <a href="http://www.dolibarr.fr">www.dolibarr.fr</a><br>

2
htdocs/societe/class/client.class.php
View File

@@ -18,7 +18,7 @@
*/ */
/** /**
* \file htdocs/societe/client.class.php * \file htdocs/societe/class/client.class.php
* \ingroup societe * \ingroup societe
* \brief File for class of customers * \brief File for class of customers
* \version $Id$ * \version $Id$