silverstripe / silverstripe-forum

code/pagetypes/Forum.php

Doc Comments +11 added lines, -6 removed lines

@@ -390,7 +390,7 @@ 
     /**
      * Get the number of total topics (threads) in this Forum
      *
-     * @return int Returns the number of topics (threads)
+     * @return string Returns the number of topics (threads)
      */
     public function getNumTopics()
     {
@@ -406,7 +406,7 @@ 
     /**
      * Get the number of total posts
      *
-     * @return int Returns the number of posts
+     * @return string Returns the number of posts
      */
     public function getNumPosts()
     {
@@ -423,7 +423,7 @@ 
     /**
      * Get the number of distinct Authors
      *
-     * @return int
+     * @return string
      */
     public function getNumAuthors()
     {
@@ -438,7 +438,7 @@ 
 
     /**
      * Returns the Topics (the first Post of each Thread) for this Forum
-     * @return DataList
+     * @return PaginatedList|null
      */
     public function getTopics()
     {
@@ -793,7 +793,7 @@ 
     /**
      * Get posts to display. This method assumes an URL parameter "ID" which contains the thread ID.
      * @param string sortDirection The sort order direction, either ASC for ascending (default) or DESC for descending
-     * @return DataObjectSet Posts
+     * @return PaginatedList Posts
      */
     public function Posts($sortDirection = "ASC")
     {
@@ -847,7 +847,7 @@ 
     /**
      * Get the usable BB codes
      *
-     * @return DataObjectSet Returns the usable BB codes
+     * @return ArrayList Returns the usable BB codes
      * @see BBCodeParser::usable_tags()
      */
     public function BBTags()
@@ -1147,6 +1147,8 @@ 
 
     /**
      * Send email to moderators notifying them the thread has been created or post added/edited.
+     * @param DataObject $post
+     * @param DataObject $thread
      */
     public function notifyModerators($post, $thread, $starting_thread = false)
     {
@@ -1488,6 +1490,9 @@ 
  */
 class Forum_DataQuery extends DataQuery
 {
+    /**
+     * @param string $dataClass
+     */
     public function __construct($dataClass, $query)
     {
         parent::__construct($dataClass);