summaryrefslogtreecommitdiff
path: root/modules/trigger/trigger.module
diff options
context:
space:
mode:
Diffstat (limited to 'modules/trigger/trigger.module')
-rw-r--r--modules/trigger/trigger.module25
1 files changed, 19 insertions, 6 deletions
diff --git a/modules/trigger/trigger.module b/modules/trigger/trigger.module
index 6c1f58ffa..55b64f09b 100644
--- a/modules/trigger/trigger.module
+++ b/modules/trigger/trigger.module
@@ -2,8 +2,7 @@
/**
* @file
- * Enables functions to be stored and executed at a later time when
- * triggered by other modules or by one of Drupal's core API hooks.
+ * Enables functions to be stored and executed at a later time.
*/
/**
@@ -158,6 +157,7 @@ function trigger_trigger_info() {
*
* @param $hook
* The name of the hook being fired.
+ *
* @return
* An array whose keys are action IDs that the user has associated with
* this trigger, and whose values are arrays containing the action type and
@@ -231,8 +231,8 @@ function _trigger_normalize_node_context($type, $node) {
*
* @param $node
* Node object.
- * @param $op
- * Operation to trigger.
+ * @param $hook
+ * Hook to trigger.
* @param $a3
* Additional argument to action function.
* @param $a4
@@ -384,8 +384,8 @@ function trigger_comment_view($comment) {
*
* @param $a1
* Comment object or array of form values.
- * @param $op
- * Operation to trigger.
+ * @param $hook
+ * Hook to trigger.
*/
function _trigger_comment($a1, $hook) {
// Keep objects for reuse so that changes actions make to objects can persist.
@@ -442,6 +442,7 @@ function trigger_cron() {
* The type of action that is about to be called.
* @param $account
* The account object that was passed via the user hook.
+ *
* @return
* The object expected by the action that is about to be called.
*/
@@ -518,6 +519,15 @@ function trigger_user_view($account) {
/**
* Calls action functions for user triggers.
+ *
+ * @param $hook
+ * The hook that called this function.
+ * @param $edit
+ * Edit variable passed in to the hook or empty array if not needed.
+ * @param $account
+ * Account variable passed in to the hook.
+ * @param $method
+ * Method variable passed in to the hook or NULL if not needed.
*/
function _trigger_user($hook, &$edit, $account, $category = NULL) {
// Keep objects for reuse so that changes actions make to objects can persist.
@@ -596,6 +606,9 @@ function trigger_actions_delete($aid) {
/**
* Retrieves and caches information from hook_trigger_info() implementations.
+ *
+ * @return
+ * Array of all triggers.
*/
function _trigger_get_all_info() {
$triggers = &drupal_static(__FUNCTION__);