summaryrefslogtreecommitdiff
path: root/modules/forum/forum.pages.inc
diff options
context:
space:
mode:
Diffstat (limited to 'modules/forum/forum.pages.inc')
-rw-r--r--modules/forum/forum.pages.inc13
1 files changed, 11 insertions, 2 deletions
diff --git a/modules/forum/forum.pages.inc b/modules/forum/forum.pages.inc
index 29307e719..8538310ac 100644
--- a/modules/forum/forum.pages.inc
+++ b/modules/forum/forum.pages.inc
@@ -2,11 +2,20 @@
/**
* @file
- * User page callbacks for the forum module.
+ * User page callbacks for the Forum module.
*/
/**
- * Menu callback; prints a forum listing.
+ * Page callback: Prints a forum listing.
+ *
+ * @param $forum_term
+ * A tree of all forums for a given taxonomy term ID. Defaults to NULL. See
+ * the return object of forum_forum_load() for a complete definition.
+ *
+ * @return
+ * A string containing HTML representing the themed forum listing.
+ *
+ * @see forum_menu()
*/
function forum_page($forum_term = NULL) {
if (!isset($forum_term)) {