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

@@ -31,6 +31,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

@@ -165,7 +165,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 +9 added lines, -4 removed lines

@@ -423,7 +423,7 @@ 
 
     /**
      * Returns the Topics (the first Post of each Thread) for this Forum
-     * @return DataList
+     * @return PaginatedList
      */
     public function getTopics()
     {
@@ -638,7 +638,7 @@ 
      *
      * Designed to be called via AJAX so return true / false
      *
-     * @return bool
+     * @return null|false
      */
     public function unsubscribe(SS_HTTPRequest $request)
     {
@@ -785,7 +785,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")
     {
@@ -817,7 +817,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()
@@ -1112,6 +1112,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)
     {
@@ -1452,6 +1454,9 @@ 
  */
 class Forum_DataQuery extends DataQuery
 {
+    /**
+     * @param string $dataClass
+     */
     public function __construct($dataClass, $query)
     {
         parent::__construct($dataClass);

code/pagetypes/ForumHolder.php

Doc Comments +3 added lines, -3 removed lines

@@ -366,7 +366,7 @@ 
 
     /**
      * Get a list of Forum Categories
-     * @return DataList
+     * @return boolean
      */
     public function getShowInCategories()
     {
@@ -532,7 +532,7 @@ 
      *                    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 int $threadID ID of the relevant topic (set to NULL for all
      *                     topics)
      * @return bool Returns TRUE if there are new posts available, otherwise
      *              FALSE.
@@ -940,7 +940,7 @@ 
     /**
      * Return the GlobalAnnouncements from the individual forums
      *
-     * @return DataObjectSet
+     * @return ArrayList
      */
     public function GlobalAnnouncements()
     {