silverstripe / silverstripe-comments

src/Controllers/CommentingController.php

Doc Comments +3 added lines, -2 removed lines

@@ -182,7 +182,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)
     {
@@ -216,7 +216,7 @@ 
     /**
      * Outputs the RSS feed of comments
      *
-     * @return HTMLText
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     public function rss()
     {
@@ -365,6 +365,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)
     {

src/Extensions/CommentsExtension.php

Doc Comments +2 added lines, -2 removed lines

@@ -275,7 +275,7 @@ 
     /**
      * Returns the root level comments, with spam and unmoderated items excluded, for use in the frontend
      *
-     * @return DataList
+     * @return \SilverStripe\ORM\SS_List
      */
     public function Comments()
     {
@@ -389,7 +389,7 @@ 
      *
      * @param Member $member
      *
-     * @return boolean
+     * @return boolean|string
      */
     public function canModerateComments($member = null)
     {

src/Model/Comment/SecurityToken.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
     private $secret = null;
 
     /**
-     * @param Comment $comment Comment to generate this token for
+     * @param \SilverStripe\ORM\DataObject|null $comment Comment to generate this token for
      */
     public function __construct($comment)
     {

tests/CommentsTest.php

Doc Comments +3 added lines

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

src/Model/Comment.php

Doc Comments +6 added lines, -6 removed lines

@@ -265,7 +265,7 @@ 
      *
      * @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)
     {
@@ -397,7 +397,7 @@ 
     /**
      * Checks if the comment can be edited.
      *
-     * @param null|int|Member $member
+     * @param DataObject|null $member
      * @return Boolean
      */
     public function canEdit($member = null)
@@ -427,7 +427,7 @@ 
     /**
      * Checks if the comment can be deleted.
      *
-     * @param null|int|Member $member
+     * @param Member|null $member
      * @return Boolean
      */
     public function canDelete($member = null)
@@ -450,7 +450,7 @@ 
      * Resolves Member object.
      *
      * @param Member|int|null $member
-     * @return Member|null
+     * @return DataObject|null
      */
     protected function getMember($member = null)
     {
@@ -816,7 +816,7 @@ 
     /**
      * Returns the list of replies, with spam and unmoderated items excluded, for use in the frontend
      *
-     * @return SS_List
+     * @return \SilverStripe\ORM\SS_List
      */
     public function Replies()
     {
@@ -867,7 +867,7 @@ 
     /**
      * Generate a reply form for this comment
      *
-     * @return Form
+     * @return null|\SilverStripe\Comments\Controllers\Form
      */
     public function ReplyForm()
     {

src/Forms/CommentForm.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
     /**
      * @param  array $data
      * @param  Form $form
-     * @return HTTPResponse
+     * @return \SilverStripe\Control\HTTPResponse
      */
     public function doPreviewComment($data, $form)
     {
@@ -171,7 +171,7 @@ 
      *
      * @param  array $data
      * @param  Form $form
-     * @return HTTPResponse
+     * @return \SilverStripe\Control\HTTPResponse
      */
     public function doPostComment($data, $form)
     {