silverstripe / silverstripe-forum

src/Models/Post.php

Doc Comments +2 added lines, -2 removed lines

@@ -355,7 +355,7 @@ 
     /**
      * Returns a ban link
      *
-     * @return bool|string
+     * @return string|false
      */
     public function BanLink()
     {
@@ -372,7 +372,7 @@ 
     /**
      * Returns a ghost link
      *
-     * @return bool|string
+     * @return string|false
      */
     public function GhostLink()
     {

src/Pages/Forum.php

Doc Comments +6 added lines, -3 removed lines

@@ -500,7 +500,7 @@ 
 
     /**
      * Returns the Topics (the first Post of each Thread) for this Forum
-     * @return DataList
+     * @return PaginatedList|null
      */
     public function getTopics()
     {
@@ -707,7 +707,7 @@ 
      *
      * Designed to be called via AJAX so return true / false
      *
-     * @return bool
+     * @return null|false
      */
     public function unsubscribe(HTTPRequest $request)
     {
@@ -1241,7 +1241,7 @@ 
     /**
      * Return the Forbidden Words in this Forum
      *
-     * @return Text
+     * @return string
      */
     public function getForbiddenWords()
     {
@@ -1547,6 +1547,9 @@ 
  */
 class Forum_DataQuery extends DataQuery
 {
+    /**
+     * @param string $dataClass
+     */
     public function __construct($dataClass, $query)
     {
         parent::__construct($dataClass);

src/Pages/ForumHolder.php

Doc Comments +6 added lines, -5 removed lines

@@ -241,7 +241,7 @@ 
     /**
      * Get the number of total posts
      *
-     * @return int Returns the number of posts
+     * @return string Returns the number of posts
      */
     public function getNumPosts()
     {
@@ -259,7 +259,7 @@ 
     /**
      * Get the number of total topics (threads)
      *
-     * @return int Returns the number of topics (threads)
+     * @return string Returns the number of topics (threads)
      */
     public function getNumTopics()
     {
@@ -277,7 +277,7 @@ 
     /**
      * Get the number of distinct authors
      *
-     * @return int Returns the number of distinct authors
+     * @return string Returns the number of distinct authors
      */
     public function getNumAuthors()
     {
@@ -377,7 +377,7 @@ 
 
     /**
      * Get a list of Forum Categories
-     * @return DataList
+     * @return boolean
      */
     public function getShowInCategories()
     {
@@ -542,8 +542,9 @@ 
      *                    it (keys: 'last_id', 'last_created')
      * @param int $lastVisit Unix timestamp of the last visit (GMT)
      * @param int $lastPostID ID of the last read post
-     * @param int $thread ID of the relevant topic (set to NULL for all
+     * @param integer $threadID ID of the relevant topic (set to NULL for all
      *                     topics)
+     * @param integer $forumID
      * @return bool Returns TRUE if there are new posts available, otherwise
      *              FALSE.
      */