aboutsummaryrefslogtreecommitdiffstats
path: root/include/plugin.php
diff options
context:
space:
mode:
authorgit-marijus <mario@mariovavti.com>2018-01-12 10:15:43 +0100
committerGitHub <noreply@github.com>2018-01-12 10:15:43 +0100
commit07b67963f128157e85c891057da2c42c286166e7 (patch)
treeb4b74f9fe5f140bc53830a12691d831ffe6cfa3a /include/plugin.php
parent47c14d3ca1078ca1c3d94096542f14a7a537266e (diff)
parentaa63c23839990045e8e4a1a283b91a1cd21e1e9c (diff)
downloadvolse-hubzilla-07b67963f128157e85c891057da2c42c286166e7.tar.gz
volse-hubzilla-07b67963f128157e85c891057da2c42c286166e7.tar.bz2
volse-hubzilla-07b67963f128157e85c891057da2c42c286166e7.zip
Merge pull request #951 from dawnbreak/docu
:bulb: Add source documentation from recent conversations.
Diffstat (limited to 'include/plugin.php')
-rwxr-xr-xinclude/plugin.php11
1 files changed, 9 insertions, 2 deletions
diff --git a/include/plugin.php b/include/plugin.php
index 379d8e799..95afdaeb5 100755
--- a/include/plugin.php
+++ b/include/plugin.php
@@ -47,7 +47,10 @@ function uninstall_plugin($plugin) {
}
/**
- * @brief installs an addon.
+ * @brief Installs an addon.
+ *
+ * This function is called once to install the addon (either from the cli or via
+ * the web admin). This will also call load_plugin() once.
*
* @param string $plugin name of the addon
* @return bool
@@ -188,7 +191,9 @@ function visible_plugin_list() {
/**
- * @brief registers a hook.
+ * @brief Registers a hook.
+ *
+ * @see ::Zotlabs::Extend::Hook::register()
*
* @param string $hook the name of the hook
* @param string $file the name of the file that hooks into
@@ -219,6 +224,8 @@ function register_hook($hook, $file, $function, $priority = 0) {
/**
* @brief unregisters a hook.
*
+ * @see ::Zotlabs::Extend::Hook::unregister
+ *
* @param string $hook the name of the hook
* @param string $file the name of the file that hooks into
* @param string $function the name of the function that the hook called