silverstripe / silverstripe-forum

code/controllers/ForumMemberProfile.php

Doc Comments +1 added lines, -1 removed lines

@@ -556,7 +556,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
 	 */
  	function Member() {

code/formfields/CheckableOption.php

Doc Comments +3 added lines

@@ -3,6 +3,9 @@
 class CheckableOption extends CompositeField {
 	protected $childField, $checkbox;
 		
+	/**
+	 * @param string $checkName
+	 */
 	function __construct($checkName, $childField, $value = "", $readonly = false) {
 		$this->name = $checkName;
 		$this->checkbox = new CheckboxField($checkName, "", $value);

code/formfields/ForumCountryDropdownField.php

Doc Comments +4 added lines

@@ -28,6 +28,10 @@
 		return i18n::get_locale();
 	}
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	function __construct($name, $title = null, $source = null, $value = "", $form=null) {
 		if(!is_array($source)) {
 			// Get a list of countries from Zend

code/model/ForumThread.php

Doc Comments +1 added lines, -1 removed lines

@@ -143,7 +143,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() {
 		if(Session::get('ForumViewed-' . $this->ID)) return false;

code/pagetypes/Forum.php

Doc Comments +10 added lines, -4 removed lines

@@ -383,7 +383,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
@@ -584,7 +584,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();
@@ -708,7 +708,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;
@@ -737,7 +737,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() {
@@ -1018,6 +1018,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();
@@ -1340,6 +1342,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;

code/pagetypes/ForumHolder.php

Doc Comments +3 added lines, -3 removed lines

@@ -337,7 +337,7 @@ 
 
 	/**
 	 * Get a list of Forum Categories
-	 * @return DataList
+	 * @return boolean
 	 */
 	function getShowInCategories() {
 	 	$forumCategories = ForumCategory::get()->filter('ForumHolderID', $this->ID);
@@ -484,7 +484,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.
@@ -857,7 +857,7 @@ 
 	/**
 	 * Return the GlobalAnnouncements from the individual forums
 	 *
-	 * @return DataObjectSet
+	 * @return ArrayList
 	 */
 	function GlobalAnnouncements() {
 		//dump(ForumHolder::baseForumTable());