silverstripe / silverstripe-forum

code/pagetypes/Forum.php

Doc Comments +13 added lines, -7 removed lines

@@ -354,7 +354,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)
 	 */
 	function getNumTopics() {
 		$sqlQuery = new SQLQuery();
@@ -369,7 +369,7 @@ 
 	/**
 	 * Get the number of total posts
 	 *
-	 * @return int Returns the number of posts
+	 * @return string Returns the number of posts
 	 */
 	function getNumPosts() {
 		$sqlQuery = new SQLQuery();
@@ -385,7 +385,7 @@ 
 	/**
 	 * Get the number of distinct Authors
 	 *
-	 * @return int
+	 * @return string
 	 */
 	function getNumAuthors() {
 		$sqlQuery = new SQLQuery();
@@ -399,7 +399,7 @@ 
 
 	/**
 	 * Returns the Topics (the first Post of each Thread) for this Forum
-	 * @return DataList
+	 * @return PaginatedList
 	 */
 	public function getTopics() {
 		// Get a list of Posts
@@ -598,7 +598,7 @@ 
 	 *
 	 * Designed to be called via AJAX so return true / false
 	 *
-	 * @return bool
+	 * @return null|false
 	 */
 	public function unsubscribe(SS_HTTPRequest $request) {
 		$member = Member::currentUser();
@@ -720,7 +720,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
 	 */
 	function Posts($sortDirection = "ASC") {
 		$numPerPage = Forum::$posts_per_page;
@@ -771,7 +771,7 @@ 
 	/**
 	 * Get the usable BB codes
 	 *
-	 * @return DataObjectSet Returns the usable BB codes
+	 * @return ArrayList Returns the usable BB codes
 	 * @see BBCodeParser::usable_tags()
 	 */
 	function BBTags() {
@@ -1053,6 +1053,8 @@ 
 
 	/**
 	 * Send email to moderators notifying them the thread has been created or post added/edited.
+	 * @param DataObject $post
+	 * @param DataObject $thread
 	 */
 	function notifyModerators($post, $thread, $starting_thread = false) {
 		$moderators = $this->Moderators();
@@ -1377,6 +1379,10 @@ 
  * TODO: Remove once API in core
  */
 class Forum_DataQuery extends DataQuery {
+
+	/**
+	 * @param string $dataClass
+	 */
 	function __construct($dataClass, $query) {
 		parent::__construct($dataClass);
 		$this->query = $query;