Commit eb45d87d authored by alban's avatar alban
Browse files

[fix] class documentation missing type

parent 6dd6094b
......@@ -33,7 +33,8 @@
class m_action {
/* --------------------------------------------------------------------------- */
/** Constructor
/**
* Constructor
*/
function m_action() {
......@@ -42,8 +43,8 @@ class m_action {
/**
* Plans the cration of a file
*
* @global type $err
* @global type $L_INOTIFY_DO_ACTION
* @global \m_err $err
* @global string $L_INOTIFY_DO_ACTION
* @return boolean
*/
function do_action() {
......@@ -58,7 +59,7 @@ class m_action {
/**
* Plans a file creation
*
* @param string $file
* @param string $file
* @param string $content
* @param int $user
* @return boolean
......@@ -91,8 +92,8 @@ class m_action {
/**
* Plans a dir fix
*
* @param type $dir
* @param type $user
* @param string $dir
* @param m_user $user
* @return type
*/
function fix_dir($dir, $user = "root") {
......@@ -102,8 +103,8 @@ class m_action {
/**
* Plans a file fix
*
* @param type $file
* @param type $user
* @param string $file
* @param m_user $user
* @return type
*/
function fix_file($file, $user = "root") {
......@@ -113,8 +114,8 @@ class m_action {
/**
* function to delete file / folder
*
* @param type $dir
* @param type $user
* @param string $dir
* @param m_user $user
* @return type
*/
function del($dir, $user = "root") {
......@@ -124,9 +125,9 @@ class m_action {
/**
* function returning the first not locked line of the action table
*
* @param type $src
* @param type $dst
* @param type $user
* @param string $src
* @param string $dst
* @param m_user $user
* @return type
*/
function move($src, $dst, $user = "root") {
......@@ -137,12 +138,12 @@ class m_action {
*
* function archiving a directory ( upon account deletion )
*
* @global type $cuid
* @global type $db
* @global type $err
* @param type $archive Directory to archive within the archive_del_data folder if set in variable sql table
* @global int $cuid
* @global m_mysql $db
* @global m_err $err
* @param string $archive Directory to archive within the archive_del_data folder if set in variable sql table
* If archive_del_data is not set we delete the folder
* @param type $dir sub_directory of the archive directory
* @param string $dir sub_directory of the archive directory
* @return boolean
*/
function archive($archive, $dir = "html") {
......@@ -172,11 +173,11 @@ class m_action {
/**
* function inserting the action in the sql table
*
* @global type $db
* @global type $err
* @param type $type
* @param type $user
* @param type $parameters
* @global m_mysql $db
* @global m_err $err
* @param string $type
* @param m_user $user
* @param mixed $parameters
* @return boolean
*/
function set($type, $user, $parameters) {
......@@ -220,8 +221,8 @@ class m_action {
/**
* This seems to be unused ?
*
* @global type $err
* @global type $db
* @global m_err $err
* @global m_mysql $db
* @param type $all
* @return boolean
*/
......@@ -239,8 +240,8 @@ class m_action {
/**
*
* @global type $err
* @global type $db
* @global m_err $err
* @global m_mysql $db
* @param type $all
* @return boolean
*/
......@@ -263,8 +264,8 @@ class m_action {
/**
* function returning the first not locked line of the action table
*
* @global type $db
* @global type $err
* @global m_mysql $db
* @global m_err $err
* @return boolean or array
*/
function get_action() {
......@@ -283,9 +284,9 @@ class m_action {
/**
* function locking an entry while it is being executed by the action script
*
* @global type $db
* @global type $err
* @param type $id
* @global m_mysql $db
* @global m_err $err
* @param int $id
* @return boolean
*/
function begin($id) {
......@@ -300,9 +301,9 @@ class m_action {
/**
* function locking an entry while it is being executed by the action script
*
* @global type $db
* @global type $err
* @param type $id
* @global m_mysql $db
* @global m_err $err
* @param int $id
* @param type $return
* @return boolean
*/
......@@ -317,9 +318,9 @@ class m_action {
/**
*
* @global type $db
* @global type $err
* @param type $id
* @global m_mysql $db
* @global m_err $err
* @param int $id
* @return boolean
*/
function reset_job($id) {
......@@ -334,8 +335,8 @@ class m_action {
/**
* Returns a list of actions marked as executable and ready for execution
*
* @global type $db
* @global type $err
* @global m_mysql $db
* @global m_err $err
* @return boolean
*/
function get_job() {
......@@ -353,8 +354,8 @@ class m_action {
/**
* function locking an entry while it is being executed by the action script
*
* @global type $db
* @param type $id
* @global m_mysql $db
* @param int $id
* @return boolean
*/
function cancel($id) {
......
......@@ -100,11 +100,11 @@ class m_variables {
*
* If $fqdn and $uid aren't specified, return the default value
*
* @global type $db
* @global type $err
* @param type $fqdn
* @param type $uid
* @param type $var
* @global m_mysql $db
* @global m_err $err
* @param string $fqdn
* @param int $uid
* @param string $var
* @return array
*/
function get_impersonated($fqdn=null, $uid=null, $var=null) {
......@@ -186,6 +186,7 @@ class m_variables {
*
* @global $conf the global conf array
* @uses variable_init()
* @param boolean $force
*/
function variable_init_maybe($force=false) {
global $conf;
......@@ -198,16 +199,16 @@ class m_variables {
/**
* Return a persistent variable.
*
* @param $name
* @param string $name
* The name of the variable to return.
* @param $default
* @param mixed $default
* The default value to use if this variable has never been set.
* @param $createit_comment
* @param string $createit_comment
* If variable doesn't exist, create it with the default value
* and createit_comment value as comment
* @return
* @return mixed
* The value of the variable.
* @global $conf
* @global array $conf
* A cache of the configuration.
*/
function variable_get($name, $default = null, $createit_comment = null, $type=null) {
......@@ -226,15 +227,15 @@ class m_variables {
/**
* Create or update a variable
*
* @global type $db
* @global type $err
* @param type $var_name
* @param type $var_value
* @param type $strata
* @param null $strata_id
* @param null $var_id
* @param type $comment
* @param type $type
* @global m_mysql $db
* @global m_err $err
* @param string $var_name
* @param mixed $var_value
* @param string $strata
* @param int $strata_id
* @param int $var_id
* @param string $comment
* @param string $type
* @return boolean
*/
function variable_update_or_create($var_name, $var_value, $strata=null, $strata_id=null, $var_id=null, $comment=null, $type=null) {
......@@ -276,9 +277,10 @@ class m_variables {
/**
* Unset a persistent variable.
*
* @param $name
* The name of the variable to undefine.
*
* @global m_mysql $db
* @param int $id
* @return type
*/
function del($id) {
global $db;
......@@ -290,9 +292,9 @@ class m_variables {
/**
* echo HTML code to display a variable passed in parameters
*
* @param type $v
* @param type $varname
* @param type $echo
* @param mixed $v
* @param string $varname
* @param boolean $echo
* @return type
*/
function display_valueraw_html($v,$varname,$echo = true) {
......@@ -357,11 +359,11 @@ class m_variables {
/**
* Display a variable if is set
*
* @param type $tab
* @param type $strata
* @param type $id
* @param type $varname
* @param type $echo
* @param array $tab
* @param string $strata
* @param int $id
* @param string $varname
* @param boolean $echo
* @return string
*/
function display_value_html($tab, $strata, $id, $varname, $echo = TRUE) {
......@@ -381,7 +383,7 @@ class m_variables {
/**
* return hashtable with variable_name => comment for all the vars
*
* @global type $db
* @global m_mysql $db
* @return type
*/
function variables_list_name() {
......@@ -402,7 +404,7 @@ class m_variables {
/**
* return a multidimensionnal array used to build vars
*
* @global type $db
* @global m_mysql $db
* @return type
*/
function variables_list() {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment