summaryrefslogtreecommitdiff
path: root/modules/forum/forum-submitted.tpl.php
diff options
context:
space:
mode:
Diffstat (limited to 'modules/forum/forum-submitted.tpl.php')
-rw-r--r--modules/forum/forum-submitted.tpl.php12
1 files changed, 7 insertions, 5 deletions
diff --git a/modules/forum/forum-submitted.tpl.php b/modules/forum/forum-submitted.tpl.php
index d310448c7..18fea8f1b 100644
--- a/modules/forum/forum-submitted.tpl.php
+++ b/modules/forum/forum-submitted.tpl.php
@@ -2,18 +2,20 @@
/**
* @file
- * Default theme implementation to format a simple string indicated when and
- * by whom a topic was submitted.
+ * Formats a forum post submission string.
*
- * Available variables:
+ * The submission string indicates when and by whom a topic was submitted.
*
+ * Available variables:
* - $author: The author of the post.
* - $time: How long ago the post was created.
- * - $topic: An object with the raw data of the post. Unsafe, be sure
- * to clean this data before printing.
+ * - $topic: An object with the raw data of the post. Potentially unsafe. Be
+ * sure to clean this data before printing.
*
* @see template_preprocess_forum_submitted()
* @see theme_forum_submitted()
+ *
+ * @ingroup themeable
*/
?>
<?php if ($time): ?>