silverstripe / silverstripe-comments

code/model/Comment.php

Doc Comments +3 added lines, -3 removed lines

@@ -316,7 +316,7 @@ 
 	/**
 	 * Checks if the comment can be edited.
 	 *
-	 * @param null|int|Member $member
+	 * @param DataObject|null $member
 	 *
 	 * @return Boolean
 	 */
@@ -346,7 +346,7 @@ 
 	/**
 	 * Checks if the comment can be deleted.
 	 *
-	 * @param null|int|Member $member
+	 * @param Member|null $member
 	 *
 	 * @return Boolean
 	 */
@@ -369,7 +369,7 @@ 
 	 * Resolves Member object.
 	 *
 	 * @param Member|int|null $member
-	 * @return Member|null
+	 * @return DataObject|null
 	 */
 	protected function getMember($member = null) {
 		if(!$member) {

code/controllers/CommentingController.php

Doc Comments +2 added lines, -1 removed lines

@@ -120,7 +120,7 @@ 
 	 * Get the commenting option for the current state
 	 *
 	 * @param string $key
-	 * @return mixed Result if the setting is available, or null otherwise
+	 * @return integer Result if the setting is available, or null otherwise
 	 */
 	public function getOption($key) {
 		// If possible use the current record
@@ -280,6 +280,7 @@ 
      * Redirect back to referer if available, ensuring that only site URLs
      * are allowed to avoid phishing.  If it's an AJAX request render the
      * comment in it's new state
+     * @param DataObject $comment
      */
     private function renderChangedCommentState($comment) {
         $referer = $this->request->getHeader('Referer');

code/Commenting.php

Doc Comments +3 added lines, -2 removed lines

@@ -23,6 +23,7 @@ 
 	 * @param string classname to add commenting to
 	 * @param array $settings Settings. See {@link self::$default_config} for
 	 *			available settings
+	 * @param string $class
 	 * 
 	 * @throws InvalidArgumentException
 	 */
@@ -72,7 +73,7 @@ 
 	 * @param string $class Class to set the value on. Passing 'all' will set it to all 
 	 *			active mappings
 	 * @param string $key setting to change
-	 * @param mixed $value value of the setting
+	 * @param string $value value of the setting
 	 */
 	public static function set_config_value($class, $key, $value = false) {
 		Deprecation::notice('2.0', 'Commenting::set_config_value is deprecated. Use the config api instead');
@@ -116,7 +117,7 @@ 
 	 * @param string $class
 	 * @param string $key
 	 * @param string $value Expected value
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public static function config_value_equals($class, $key, $value) {
 		$check = self::get_config_value($class, $key);

tests/CommentAdminTest.php

Doc Comments +3 added lines

@@ -43,6 +43,9 @@
         $form = $commentAdmin->getEditForm();
 	}
 
+    /**
+     * @param Form $form
+     */
     private function getFormFieldNames($form) {
         $result = array();
         $fields = $form->Fields();

tests/CommentsTest.php

Doc Comments +3 added lines

@@ -1196,6 +1196,9 @@
     }
 
 
+    /**
+     * @param string $name
+     */
     protected static function getMethod($name) {
         $class = new ReflectionClass('Comment');
         $method = $class->getMethod($name);