silverstripe / silverstripe-forum

code/controllers/ForumMemberProfile.php

Doc Comments +1 added lines, -1 removed lines

@@ -578,7 +578,7 @@
     /**
      * Return the with the passed ID (via URL parameters) or the current user
      *
-     * @return null|Member Returns the member object or NULL if the member
+     * @return DataObject|null Returns the member object or NULL if the member
      *                     was not found
      */
     public function Member()

code/formfields/ForumCountryDropdownField.php

Doc Comments +4 added lines

@@ -32,6 +32,10 @@
         return i18n::get_locale();
     }
 
+    /**
+     * @param string $name
+     * @param string $title
+     */
     public function __construct($name, $title = null, $source = null, $value = "", $form = null)
     {
         if (!is_array($source)) {

code/model/ForumThread.php

Doc Comments +1 added lines, -1 removed lines

@@ -169,7 +169,7 @@
      * Check if they have visited this thread before. If they haven't increment
      * the NumViews value by 1 and set visited to true.
      *
-     * @return void
+     * @return false|null
      */
     public function incNumViews()
     {

code/pagetypes/Forum.php

Doc Comments +12 added lines, -7 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()
     {
@@ -645,7 +645,7 @@ 
      *
      * Designed to be called via AJAX so return true / false
      *
-     * @return bool
+     * @return null|false
      */
     public function unsubscribe(SS_HTTPRequest $request)
     {
@@ -790,7 +790,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")
     {
@@ -844,7 +844,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()
@@ -1144,6 +1144,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)
     {
@@ -1485,6 +1487,9 @@ 
  */
 class Forum_DataQuery extends DataQuery
 {
+    /**
+     * @param string $dataClass
+     */
     public function __construct($dataClass, $query)
     {
         parent::__construct($dataClass);

code/pagetypes/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.
      */