diff options
author | Klaus Weidenbach <Klaus.Weidenbach@gmx.net> | 2019-01-18 22:17:10 +0100 |
---|---|---|
committer | Klaus Weidenbach <Klaus.Weidenbach@gmx.net> | 2019-01-23 22:25:47 +0100 |
commit | 13e0151cd2569832588cc9a973bcf40d850edd53 (patch) | |
tree | 1d2054ca8b9edd9435d1ffa4c2584afea9121102 /include/plugin.php | |
parent | 51a7be29f50c4c62a2afb0ed155df43af9351fad (diff) | |
download | volse-hubzilla-13e0151cd2569832588cc9a973bcf40d850edd53.tar.gz volse-hubzilla-13e0151cd2569832588cc9a973bcf40d850edd53.tar.bz2 volse-hubzilla-13e0151cd2569832588cc9a973bcf40d850edd53.zip |
Correct and extend Doxygen comments.
Correct some documentation errors for Doxygen and add
more comments.
Document some undefined variables with @FIXME.
Diffstat (limited to 'include/plugin.php')
-rwxr-xr-x | include/plugin.php | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/include/plugin.php b/include/plugin.php index ec14fd945..c789ad522 100755 --- a/include/plugin.php +++ b/include/plugin.php @@ -7,13 +7,15 @@ /** - * @brief Handle errors in plugin calls + * @brief Handle errors in plugin calls. * * @param string $plugin name of the addon - * @param string $error_text text of error - * @param bool $uninstall uninstall plugin + * @param string $notice UI visible text of error + * @param string $log technical error message for logging + * @param bool $uninstall (optional) default false + * uninstall plugin on error */ -function handleerrors_plugin($plugin,$notice,$log,$uninstall=false){ +function handleerrors_plugin($plugin, $notice, $log, $uninstall = false){ logger("Addons: [" . $plugin . "] Error: ".$log, LOGGER_ERROR); if ($notice != '') { notice("[" . $plugin . "] Error: ".$notice, LOGGER_ERROR); @@ -23,7 +25,7 @@ function handleerrors_plugin($plugin,$notice,$log,$uninstall=false){ $idx = array_search($plugin, \App::$plugins); unset(\App::$plugins[$idx]); uninstall_plugin($plugin); - set_config("system","addon", implode(", ",\App::$plugins)); + set_config("system", "addon", implode(", ", \App::$plugins)); } } @@ -381,8 +383,6 @@ function unregister_hook($hook, $file, $function) { * array in their theme_init() and use this to customise the app behaviour. * use insert_hook($hookname,$function_name) to do this. */ - - function load_hooks() { App::$hooks = []; @@ -1085,10 +1085,11 @@ function get_markup_template($s, $root = '') { } /** - * @brief + * @brief Test if a folder exists. * * @param string $folder * @return boolean|string + * False if folder does not exist, or canonicalized absolute pathname */ function folder_exists($folder) { // Get canonicalized absolute pathname |