From 48e5e8394cd3296c0bb9fe6eaf0580ecee4d2349 Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Mon, 16 Apr 2012 14:09:06 -0500 Subject: [PATCH] Issue #1532682 by TravisCarden: Fixed documentation of comment_reply() return value. --- core/modules/comment/comment.pages.inc | 8 ++++++-- 1 files changed, 6 insertions(+), 2 deletions(-) diff --git a/core/modules/comment/comment.pages.inc b/core/modules/comment/comment.pages.inc index bac078b..7e4c4ea 100644 --- a/core/modules/comment/comment.pages.inc +++ b/core/modules/comment/comment.pages.inc @@ -25,8 +25,12 @@ use Drupal\node\Node; * (optional) Some comments are replies to other comments. In those cases, * $pid is the parent comment's comment ID. Defaults to NULL. * - * @return - * The rendered parent node or comment plus the new comment form. + * @return array + * An associative array containing: + * - An array for rendering the node or parent comment. + * - comment_node: If the comment is a reply to the node. + * - comment_parent: If the comment is a reply to another comment. + * - comment_form: The comment form as a renderable array. */ function comment_reply(Node $node, $pid = NULL) { // Set the breadcrumb trail. -- 1.7.4.1