From e2255008287112963d168d3a55c242bf22032e59 Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Mon, 7 Dec 2015 10:40:27 -0800
Subject: [PATCH] Issue #2607332 by r_sharma08, ashhishhh, snehi, pjonckiere,
dawehner: Missing @return tag in getActiveHelp(), denormalize(),
createBookNode()
(cherry picked from commit 0a97f790727b7a1a9499cfe42ec08832acada02d)
---
core/modules/book/src/Tests/BookTest.php | 3 +++
core/modules/hal/src/Normalizer/ContentEntityNormalizer.php | 3 +++
core/modules/help/src/Plugin/Block/HelpBlock.php | 3 +++
3 files changed, 9 insertions(+)
diff --git a/core/modules/book/src/Tests/BookTest.php b/core/modules/book/src/Tests/BookTest.php
index b1c9fa3f2893..54d0fafd1ee2 100644
--- a/core/modules/book/src/Tests/BookTest.php
+++ b/core/modules/book/src/Tests/BookTest.php
@@ -338,6 +338,9 @@ function generateOutlinePattern($nodes) {
* A book node ID or set to 'new' to create a new book.
* @param int|null $parent
* (optional) Parent book reference ID. Defaults to NULL.
+ *
+ * @return \Drupal\node\NodeInterface
+ * The created node.
*/
function createBookNode($book_nid, $parent = NULL) {
// $number does not use drupal_static as it should not be reset
diff --git a/core/modules/hal/src/Normalizer/ContentEntityNormalizer.php b/core/modules/hal/src/Normalizer/ContentEntityNormalizer.php
index 9c71da403058..e7a0388e16cd 100644
--- a/core/modules/hal/src/Normalizer/ContentEntityNormalizer.php
+++ b/core/modules/hal/src/Normalizer/ContentEntityNormalizer.php
@@ -124,6 +124,9 @@ public function normalize($entity, $format = NULL, array $context = array()) {
* all default values for entity fields before applying $data to the
* entity.
*
+ * @return \Drupal\Core\Entity\EntityInterface
+ * An unserialized entity object containing the data in $data.
+ *
* @throws \Symfony\Component\Serializer\Exception\UnexpectedValueException
*/
public function denormalize($data, $class, $format = NULL, array $context = array()) {
diff --git a/core/modules/help/src/Plugin/Block/HelpBlock.php b/core/modules/help/src/Plugin/Block/HelpBlock.php
index cae2b6ef8a8e..af71928a45bc 100644
--- a/core/modules/help/src/Plugin/Block/HelpBlock.php
+++ b/core/modules/help/src/Plugin/Block/HelpBlock.php
@@ -89,6 +89,9 @@ public static function create(ContainerInterface $container, array $configuratio
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The current request.
+ *
+ * @return string
+ * Help text of the matched route item as HTML.
*/
protected function getActiveHelp(Request $request) {
// Do not show on a 403 or 404 page.
--
GitLab