From 996c6ceaff8f78bd3ee7ab50b6093c3a2f9ada8e Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Wed, 27 Oct 2010 22:53:37 +0000
Subject: [PATCH] Doxygen
---
build/doxygen/dolibarr-doxygen.doxyfile | 1 +
build/makepack-dolibarrlang.pl | 2 +-
build/makepack-dolibarrtheme.pl | 2 +-
.../expedition/methode_expedition.modules.php | 13 ++++----
.../methode_expedition_colsui.modules.php | 31 ++++++++++---------
.../methode_expedition_enl.modules.php | 15 ++++-----
.../methode_expedition_trans.modules.php | 17 +++++-----
7 files changed, 42 insertions(+), 39 deletions(-)
diff --git a/build/doxygen/dolibarr-doxygen.doxyfile b/build/doxygen/dolibarr-doxygen.doxyfile
index 69d90f6731e..23531ed547a 100644
--- a/build/doxygen/dolibarr-doxygen.doxyfile
+++ b/build/doxygen/dolibarr-doxygen.doxyfile
@@ -625,6 +625,7 @@ EXCLUDE = ../../mssql \
../../htdocs/includes/adodbtime \
../../htdocs/includes/artichow \
../../htdocs/includes/barcode \
+ ../../htdocs/includes/ckeditor \
../../htdocs/includes/efc_xfss \
../../htdocs/includes/fckeditor \
../../htdocs/includes/fpdf \
diff --git a/build/makepack-dolibarrlang.pl b/build/makepack-dolibarrlang.pl
index e81dabcfaec..6d9e3e4b9c2 100644
--- a/build/makepack-dolibarrlang.pl
+++ b/build/makepack-dolibarrlang.pl
@@ -78,7 +78,7 @@ print "Makepack langs version $VERSION\n";
print "Enter language code to package (en_US, fr_FR, ...) : ";
$PROJECT=<STDIN>;
chomp($PROJECT);
-# \todo Autodetect version
+# TODO Autodetect version
# Ask and set version $MAJOR and $MINOR
print "Enter value for version: ";
$PROJVERSION=<STDIN>;
diff --git a/build/makepack-dolibarrtheme.pl b/build/makepack-dolibarrtheme.pl
index 18d43775dc4..9d2cf83fe3e 100644
--- a/build/makepack-dolibarrtheme.pl
+++ b/build/makepack-dolibarrtheme.pl
@@ -78,7 +78,7 @@ print "Makepack theme version $VERSION\n";
print "Enter name of theme to package: ";
$PROJECT=<STDIN>;
chomp($PROJECT);
-# \todo Autodetect version
+# TODO Autodetect version
# Ask and set version $MAJOR and $MINOR
print "Enter value for version: ";
$PROJVERSION=<STDIN>;
diff --git a/htdocs/includes/modules/expedition/methode_expedition.modules.php b/htdocs/includes/modules/expedition/methode_expedition.modules.php
index fba232c5230..5fe436eb5c5 100644
--- a/htdocs/includes/modules/expedition/methode_expedition.modules.php
+++ b/htdocs/includes/modules/expedition/methode_expedition.modules.php
@@ -25,19 +25,18 @@
* et la classe mere de numerotation des bons de livraisons
* \version $Id$
*/
-
require_once(DOL_DOCUMENT_ROOT.'/lib/pdf.lib.php');
require_once(DOL_DOCUMENT_ROOT.'/includes/fpdf/fpdfi/fpdi_protection.php');
/**
- * \class methode_expedition
- * \brief Classe mere des methodes expeditions
+ * \class ModeleShippingMethod
+ * \brief Parent class for shipping method classes
*/
-class methode_expedition
+class ModeleShippingMethod
{
- function methode_expedition($db=0)
+ function ModeleShippingMethod($db=0)
{
$this->db = $db;
$this->name = "NOT DEFINED";
@@ -46,8 +45,8 @@ class methode_expedition
/**
- * \brief Return list of active generation modules
- * \param $db Database handler
+ * Return list of active generation modules
+ * @param $db Database handler
*/
function liste_modeles($db)
{
diff --git a/htdocs/includes/modules/expedition/methode_expedition_colsui.modules.php b/htdocs/includes/modules/expedition/methode_expedition_colsui.modules.php
index cb3133d6563..4e4165f66f4 100644
--- a/htdocs/includes/modules/expedition/methode_expedition_colsui.modules.php
+++ b/htdocs/includes/modules/expedition/methode_expedition_colsui.modules.php
@@ -16,29 +16,30 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
+/**
+ * \file htdocs/includes/modules/expedition/methode_expedition_colsui.modules.php
+ * \ingroup expedition
* \version $Id$
*/
-
include_once "methode_expedition.modules.php";
-Class methode_expedition_colsui extends methode_expedition
+class methode_expedition_colsui extends ModeleShippingMethod
{
- function methode_expedition_colsui($db=0)
- {
- $this->db = $db;
- $this->id = 3; // Do not change this value
- $this->code = "COLSUI"; // Do not change this value
- $this->name = "Colissimo Suivi";
- $this->description = "Colissimo Suivi";
- }
+ function methode_expedition_colsui($db=0)
+ {
+ $this->db = $db;
+ $this->id = 3; // Do not change this value
+ $this->code = "COLSUI"; // Do not change this value
+ $this->name = "Colissimo Suivi";
+ $this->description = "Colissimo Suivi";
+ }
- Function provider_url_status($tracking_number)
- {
- return sprintf("http://www.coliposte.net/particulier/suivi_particulier.jsp?colispart=%s",$tracking_number);
- }
+ function provider_url_status($tracking_number)
+ {
+ return sprintf("http://www.coliposte.net/particulier/suivi_particulier.jsp?colispart=%s",$tracking_number);
+ }
}
?>
diff --git a/htdocs/includes/modules/expedition/methode_expedition_enl.modules.php b/htdocs/includes/modules/expedition/methode_expedition_enl.modules.php
index 2c689e71969..d03b77ee7b8 100644
--- a/htdocs/includes/modules/expedition/methode_expedition_enl.modules.php
+++ b/htdocs/includes/modules/expedition/methode_expedition_enl.modules.php
@@ -15,14 +15,15 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
+/**
+ * \file htdocs/includes/modules/expedition/methode_expedition_enl.modules.php
+ * \ingroup expedition
* \version $Id$
*/
-
include_once "methode_expedition.modules.php";
-Class methode_expedition_enl extends methode_expedition
+class methode_expedition_enl extends ModeleShippingMethod
{
function methode_expedition_enl($db=0)
@@ -34,11 +35,11 @@ Class methode_expedition_enl extends methode_expedition
$this->code = "ENL";
$this->description = $langs->trans("Enlevement");
}
-
+
Function provider_url_status($tracking_number)
- {
- return '';
- }
+ {
+ return '';
+ }
}
?>
diff --git a/htdocs/includes/modules/expedition/methode_expedition_trans.modules.php b/htdocs/includes/modules/expedition/methode_expedition_trans.modules.php
index 2954592ac66..5c0f008a503 100644
--- a/htdocs/includes/modules/expedition/methode_expedition_trans.modules.php
+++ b/htdocs/includes/modules/expedition/methode_expedition_trans.modules.php
@@ -15,31 +15,32 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
+/**
+ * \file htdocs/includes/modules/expedition/methode_expedition_trans.modules.php
+ * \ingroup expedition
* \version $Id$
*/
-
include_once "methode_expedition.modules.php";
-Class methode_expedition_trans extends methode_expedition
+class methode_expedition_trans extends ModeleShippingMethod
{
function methode_expedition_trans($db=0)
{
global $langs;
-
+
$this->db = $db;
$this->id = 2; // Ne pas changer cette valeur
$this->code = "TRANS";
$this->name = "Transporteur";
$this->description = $langs->trans("GenericTransport");
}
-
+
Function provider_url_status($tracking_number)
- {
- return '';
- }
+ {
+ return '';
+ }
}
?>
--
GitLab