diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module index 4978551..63e381d 100644 --- a/core/modules/comment/comment.module +++ b/core/modules/comment/comment.module @@ -276,9 +276,9 @@ function comment_prepare_thread(&$comments) { * * @param \Drupal\comment\CommentInterface $comment * The comment object. - * @param $view_mode + * @param string $view_mode * (optional) View mode, e.g. 'full', 'teaser'... Defaults to 'full'. - * @param $langcode + * @param string|NULL $langcode * (optional) A language code to use for rendering. Defaults to the global * content language of the current request. * @@ -292,11 +292,11 @@ function comment_view(CommentInterface $comment, $view_mode = 'full', $langcode /** * Constructs render array from an array of loaded comments. * - * @param $comments + * @param array $comments * An array of comments as returned by entity_load_multiple(). - * @param $view_mode - * View mode, e.g. 'full', 'teaser'... - * @param $langcode + * @param string $view_mode + * (optional) View mode, e.g. 'full', 'teaser', etc. Defaults to 'full'. + * @param string|NULL $langcode * (optional) A string indicating the language field values are to be shown * in. If no language is provided the current content language is used. * Defaults to NULL. diff --git a/core/modules/comment/src/CommentForm.php b/core/modules/comment/src/CommentForm.php index fbb7442..476de68 100644 --- a/core/modules/comment/src/CommentForm.php +++ b/core/modules/comment/src/CommentForm.php @@ -333,9 +333,9 @@ public function submitForm(array &$form, FormStateInterface $form_state) { /** * Form submission handler for the 'preview' action. * - * @param $form + * @param array $form * An associative array containing the structure of the form. - * @param $form_state + * @param Drupal\Core\Form\FormStateInterface $form_state * The current state of the form. */ public function preview(array &$form, FormStateInterface $form_state) { diff --git a/core/modules/comment/src/Tests/CommentNonNodeTest.php b/core/modules/comment/src/Tests/CommentNonNodeTest.php index 704a298..71610e1 100644 --- a/core/modules/comment/src/Tests/CommentNonNodeTest.php +++ b/core/modules/comment/src/Tests/CommentNonNodeTest.php @@ -85,13 +85,13 @@ protected function setUp() { * * @param \Drupal\Core\Entity\EntityInterface|null $entity * Entity to post comment on or NULL to post to the previously loaded page. - * @param $comment + * @param string $comment * Comment body. - * @param $subject - * Comment subject. - * @param $contact - * Set to NULL for no contact info, TRUE to ignore success checking, and - * array of values to set contact info. + * @param string $subject + * (optional) Comment subject. + * @param array|bool|NULL $contact + * (optional) Set to NULL for no contact info, TRUE to ignore success + * checking, or an array of values to set contact info. */ function postComment(EntityInterface $entity, $comment, $subject = '', $contact = NULL) { $edit = array(); @@ -159,10 +159,10 @@ function postComment(EntityInterface $entity, $comment, $subject = '', $contact * * @param \Drupal\comment\CommentInterface $comment * The comment object. - * @param boolean $reply + * @param bool $reply * Boolean indicating whether the comment is a reply to another comment. * - * @return boolean + * @return bool * Boolean indicating whether the comment was found. */ function commentExists(CommentInterface $comment = NULL, $reply = FALSE) { @@ -183,7 +183,7 @@ function commentExists(CommentInterface $comment = NULL, $reply = FALSE) { /** * Checks whether the commenter's contact information is displayed. * - * @return boolean + * @return bool * Contact info is available. */ function commentContactInfoAvailable() { @@ -197,7 +197,7 @@ function commentContactInfoAvailable() { * Comment to perform operation on. * @param string $operation * Operation to perform. - * @param boolean $aproval + * @param bool $approval * Operation is found on approval page. */ function performCommentOperation($comment, $operation, $approval = FALSE) { @@ -221,7 +221,7 @@ function performCommentOperation($comment, $operation, $approval = FALSE) { * @param string $subject * Comment subject to find. * - * @return integer + * @return int * Comment ID. */ function getUnapprovedComment($subject) { diff --git a/core/modules/comment/src/Tests/CommentPagerTest.php b/core/modules/comment/src/Tests/CommentPagerTest.php index 18bb32d..791c365 100644 --- a/core/modules/comment/src/Tests/CommentPagerTest.php +++ b/core/modules/comment/src/Tests/CommentPagerTest.php @@ -167,9 +167,9 @@ function testCommentOrderingThreading() { /** * Asserts that the comments are displayed in the correct order. * - * @param $comments - * And array of comments. - * @param $expected_order + * @param array $comments + * An array of comments. + * @param array $expected_order * An array of keys from $comments describing the expected order. */ function assertCommentOrder(array $comments, array $expected_order) {