lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2011-08-31 10:41:06 +00:00
parent 14c5efdfa4
commit 8b772eef30
5 changed files with 68 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -31,7 +31,7 @@ PROJECT_NAME = dolibarr
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
# if some version control system is used. # if some version control system is used.
PROJECT_NUMBER = 3.1.0 PROJECT_NUMBER = 3.2.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put. # base path where the generated documentation will be put.

10
dev/skeletons/modMyModule.class.php
View File

@ -232,9 +232,10 @@ class modMyModule extends DolibarrModules
* The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
* It also creates data directories * It also creates data directories
* *
* @return int 1 if OK, 0 if KO * @param string $options Options when enabling module ('', 'noboxes')
* @return int 1 if OK, 0 if KO
*/ */
function init() function init($options='')
{ {
$sql = array(); $sql = array();
@ -248,9 +249,10 @@ class modMyModule extends DolibarrModules
* Remove from database constants, boxes and permissions from Dolibarr database. * Remove from database constants, boxes and permissions from Dolibarr database.
* Data directories are not deleted * Data directories are not deleted
* *
* @return int 1 if OK, 0 if KO * @param string $options Options when enabling module ('', 'noboxes')
* @return int 1 if OK, 0 if KO
*/ */
function remove() function remove($options='')
{ {
$sql = array(); $sql = array();

34
htdocs/includes/modules/DolibarrModules.class.php
View File

@ -54,6 +54,7 @@ abstract class DolibarrModules
/** /**
* Constructor * Constructor
*
* @param DB Database access handler * @param DB Database access handler
*/ */
function DolibarrModules($DB) function DolibarrModules($DB)
@ -65,9 +66,10 @@ abstract class DolibarrModules
/** /**
* Fonction d'activation. Insere en base les constantes et boites du module * Fonction d'activation. Insere en base les constantes et boites du module
* @param array_sql Tableau de requete sql a executer a l'activation *
* @param options Options when enabling module ('', 'noboxes') * @param array $array_sql Array of SQL requests to execute when enabling module
* @return int 1 if OK, 0 if KO * @param string $options Options when enabling module ('', 'noboxes')
* @return int 1 if OK, 0 if KO
*/ */
function _init($array_sql, $options='') function _init($array_sql, $options='')
{ {
@ -163,9 +165,10 @@ abstract class DolibarrModules
/** /**
* Fonction de desactivation. Supprime de la base les constantes et boites du module * Fonction de desactivation. Supprime de la base les constantes et boites du module
* @param array_sql tableau de requete sql a executer a la desactivation *
* @param options Options when disabling module ('', 'noboxes') * @param array $array_sql Array of SQL requests to execute when disable module
* @return int 1 if OK, 0 if KO * @param string $options Options when disabling module ('', 'noboxes')
* @return int 1 if OK, 0 if KO
*/ */
function _remove($array_sql, $options='') function _remove($array_sql, $options='')
{ {
@ -481,7 +484,8 @@ abstract class DolibarrModules
* Create tables and keys required by module. * Create tables and keys required by module.
* Files module.sql and module.key.sql with create table and create keys * Files module.sql and module.key.sql with create table and create keys
* commands must be stored in directory reldir='/module/sql/' * commands must be stored in directory reldir='/module/sql/'
* This function is called by this->init. * This function is called by this->init
*
* @return int <=0 if KO, >0 if OK * @return int <=0 if KO, >0 if OK
*/ */
function _load_tables($reldir) function _load_tables($reldir)
@ -680,6 +684,7 @@ abstract class DolibarrModules
/** /**
* Desactive feuille de style du module par suppression ligne dans llx_const * Desactive feuille de style du module par suppression ligne dans llx_const
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function delete_style_sheet() function delete_style_sheet()
@ -708,6 +713,7 @@ abstract class DolibarrModules
/** /**
* Remove links to new module page present in llx_const * Remove links to new module page present in llx_const
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function delete_tabs() function delete_tabs()
@ -733,6 +739,7 @@ abstract class DolibarrModules
/** /**
* Active la feuille de style associee au module par insertion ligne dans llx_const * Active la feuille de style associee au module par insertion ligne dans llx_const
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function insert_style_sheet() function insert_style_sheet()
@ -775,6 +782,7 @@ abstract class DolibarrModules
/** /**
* Add links of new pages from modules in llx_const * Add links of new pages from modules in llx_const
*
* @return int Number of errors (0 if ok) * @return int Number of errors (0 if ok)
*/ */
function insert_tabs() function insert_tabs()
@ -824,6 +832,7 @@ abstract class DolibarrModules
/** /**
* Insert constants defined into $this->const array into table llx_const * Insert constants defined into $this->const array into table llx_const
*
* @return int Number of errors (0 if OK) * @return int Number of errors (0 if OK)
*/ */
function insert_const() function insert_const()
@ -891,6 +900,7 @@ abstract class DolibarrModules
/** /**
* Remove constants with tags deleteonunactive * Remove constants with tags deleteonunactive
*
* @return int <0 if KO, 0 if OK * @return int <0 if KO, 0 if OK
*/ */
function delete_const() function delete_const()
@ -924,6 +934,7 @@ abstract class DolibarrModules
/** /**
* Insert permissions definitions related to the module into llx_rights_def * Insert permissions definitions related to the module into llx_rights_def
*
* @param $reinitadminperms If 1, we also grant them to all admin users * @param $reinitadminperms If 1, we also grant them to all admin users
* @return int Number of error (0 if OK) * @return int Number of error (0 if OK)
*/ */
@ -1047,6 +1058,7 @@ abstract class DolibarrModules
/** /**
* Delete permissions * Delete permissions
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function delete_permissions() function delete_permissions()
@ -1167,6 +1179,7 @@ abstract class DolibarrModules
/** /**
* Remove menus entries * Remove menus entries
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function delete_menus() function delete_menus()
@ -1193,6 +1206,7 @@ abstract class DolibarrModules
/** /**
* Create directories required by module * Create directories required by module
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function create_dirs() function create_dirs()
@ -1250,6 +1264,7 @@ abstract class DolibarrModules
/** /**
* Insert directories in llx_const * Insert directories in llx_const
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function insert_dirs($name,$dir) function insert_dirs($name,$dir)
@ -1291,6 +1306,7 @@ abstract class DolibarrModules
/** /**
* Remove directory entries * Remove directory entries
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function delete_dirs() function delete_dirs()
@ -1316,6 +1332,7 @@ abstract class DolibarrModules
/** /**
* Insert activation triggers from modules in llx_const * Insert activation triggers from modules in llx_const
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function insert_triggers() function insert_triggers()
@ -1356,6 +1373,7 @@ abstract class DolibarrModules
/** /**
* Remove activation triggers from modules in llx_const * Remove activation triggers from modules in llx_const
*
* @return int Nb of errors (0 if OK) * @return int Nb of errors (0 if OK)
*/ */
function delete_triggers() function delete_triggers()
@ -1381,6 +1399,7 @@ abstract class DolibarrModules
/** /**
* Insert activation login method from modules in llx_const * Insert activation login method from modules in llx_const
*
* @return int Number of errors (0 if ok) * @return int Number of errors (0 if ok)
*/ */
function insert_login_method() function insert_login_method()
@ -1421,6 +1440,7 @@ abstract class DolibarrModules
/** /**
* Remove activation login method from modules in llx_const * Remove activation login method from modules in llx_const
*
* @return int Nombre d'erreurs (0 si ok) * @return int Nombre d'erreurs (0 si ok)
*/ */
function delete_login_method() function delete_login_method()

21
htdocs/includes/modules/modAccounting.class.php
View File

@ -37,8 +37,9 @@ class modAccounting extends DolibarrModules
{ {
/** /**
* \brief Constructeur. Definit les noms, constantes et boites * Constructor. Define names, constants, directories, boxes, permissions
* \param DB handler d'acces base *
* @param DoliDB $DB Database handler
*/ */
function modAccounting($DB) function modAccounting($DB)
{ {
@ -129,8 +130,12 @@ class modAccounting extends DolibarrModules
/** /**
* \brief Fonction appelee lors de l'activation du module. Insere en base les constantes, boites, permissions du module. * Function called when module is enabled.
* Definit egalement les repertoires de donnees e creer pour ce module. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
* It also creates data directories
*
* @param string $options Options when enabling module ('', 'noboxes')
* @return int 1 if OK, 0 if KO
*/ */
function init($options='') function init($options='')
{ {
@ -143,8 +148,12 @@ class modAccounting extends DolibarrModules
} }
/** /**
* \brief Fonction appelee lors de la desactivation d'un module. * Function called when module is enabled.
* Supprime de la base les constantes, boites et permissions du module. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
* It also creates data directories
*
* @param string $options Options when enabling module ('', 'noboxes')
* @return int 1 if OK, 0 if KO
*/ */
function remove($options='') function remove($options='')
{ {

29
htdocs/includes/modules/modAdherent.class.php
View File

@ -37,8 +37,9 @@ class modAdherent extends DolibarrModules
{ {
/** /**
* \brief Constructeur. Definit les noms, constantes et boites * Constructor. Define names, constants, directories, boxes, permissions
* \param DB Database handler *
* @param DoliDB $DB Database handler
*/ */
function modAdherent($DB) function modAdherent($DB)
{ {
@ -220,26 +221,34 @@ class modAdherent extends DolibarrModules
/** /**
* \brief Fonction appelee lors de l'activation du module. Insere en base les constantes, boites, permissions du module. * Function called when module is enabled.
* Definit egalement les repertoires de donnees a creer pour ce module. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
* It also creates data directories
*
* @param string $options Options when enabling module ('', 'noboxes')
* @return int 1 if OK, 0 if KO
*/ */
function init() function init($options='')
{ {
$sql = array(); $sql = array();
return $this->_init($sql); return $this->_init($sql,$options);
} }
/** /**
* \brief Fonction appelee lors de la desactivation d'un module. * Function called when module is disabled.
* Supprime de la base les constantes, boites et permissions du module. * Remove from database constants, boxes and permissions from Dolibarr database.
* Data directories are not deleted
*
* @param string $options Options when enabling module ('', 'noboxes')
* @return int 1 if OK, 0 if KO
*/ */
function remove() function remove($options='')
{ {
$sql = array(); $sql = array();
return $this->_remove($sql); return $this->_remove($sql,$options);
} }
} }