From 970b096f42cf92efee84989086a2e5d215a1ffe0 Mon Sep 17 00:00:00 2001 From: Angie Byron Date: Sat, 10 Oct 2009 17:29:17 +0000 Subject: #360023 by stella, sun, greggles: Added 'Publish comment' action + doxygen fixes. --- includes/actions.inc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'includes/actions.inc') diff --git a/includes/actions.inc b/includes/actions.inc index 3ef5b848a..ce196cfe5 100644 --- a/includes/actions.inc +++ b/includes/actions.inc @@ -6,6 +6,25 @@ * This is the actions engine for executing stored actions. */ +/** + * @defgroup actions Actions + * @{ + * Functions that perform an action on a certain system object. + * + * All modules should declare their action functions to be in this group and + * each action function should reference its configuration form, validate, and + * submit functions using \@see. Conversely, form, validate, and submit + * functions should reference the action function using \@see. For examples of + * this see comment_unpublish_by_keyword_action(), which has the following in + * its doxygen documentation: + * + * \@ingroup actions + * \@see comment_unpublish_by_keyword_action_form(). + * \@see comment_unpublish_by_keyword_action_submit(). + * + * @} End of "defgroup actions". + */ + /** * Performs a given list of actions by executing their callback functions. * -- cgit v1.2.3