From b84b6e42cf2f6d64772f20d695258c83f0652fa1 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Thu, 9 Sep 2004 05:51:08 +0000
Subject: - Patch #10663 by JonBob: documentation improvements: fixed some
 typos and improved consistency to the use of Doxygen/api.module commands in
 the comments.

---
 modules/forum/forum.module | 29 +++--------------------------
 1 file changed, 3 insertions(+), 26 deletions(-)

(limited to 'modules/forum/forum.module')

diff --git a/modules/forum/forum.module b/modules/forum/forum.module
index 9be309d16..478827107 100644
--- a/modules/forum/forum.module
+++ b/modules/forum/forum.module
@@ -490,22 +490,10 @@ function forum_page($tid = 0, $display = 'all') {
   }
 }
 
-/**
- * @addtogroup themeable
- * @{
- */
-
 /**
  * Format the forum body.
  *
- * @param forums
- * @param topics
- * @param parents
- * @param tid
- * @param sortby
- * @param forum_per_page
- *
- * @return the output for the forum body.
+ * @ingroup themeable
  */
 function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
   global $user;
@@ -575,11 +563,7 @@ function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_p
 /**
  * Format the forum listing.
  *
- * @param forums
- * @param parents
- * @param tid
- *
- * @return output for the forum listing.
+ * @ingroup themeable
  */
 function theme_forum_list($forums, $parents, $tid) {
   global $user;
@@ -632,12 +616,7 @@ function theme_forum_list($forums, $parents, $tid) {
 /**
  * Format the topic listing.
  *
- * @param tid
- * @param topics
- * @param sortby
- * @param forum_per_page
- *
- * @return output for the topic list.
+ * @ingroup themeable
  */
 function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page) {
   global $forum_topic_list_header;
@@ -674,8 +653,6 @@ function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page) {
   return $output;
 }
 
-/** @} End of addtogroup themeable */
-
 function _forum_icon($new_posts, $num_posts = 0, $comment_mode = 0, $sticky = 0) {
 
   $base_path = variable_get('forum_icon_path', '');
-- 
cgit v1.2.3