#360023 by stella, sun, greggles: Added 'Publish comment' action + doxygen fixes.

1 files changed, 19 insertions, 0 deletions

diff --git a/includes/actions.inc b/includes/actions.inc
index 3ef5b848a..ce196cfe5 100644
--- a/includes/actions.inc
+++ b/includes/actions.inc
@@ -7,6 +7,25 @@
  */
 
 /**
+ * @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.
  *
  * Given the IDs of actions to perform, this function finds out what the