diff options
| author | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-06-06 08:39:15 -0700 |
|---|---|---|
| committer | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-06-06 08:39:15 -0700 |
| commit | 93a96563fb44ca5683b4ae809972b6ea1eacf99d (patch) | |
| tree | 519616421f951d97aa108a36f9e3147ca1f15ac7 /modules/comment/comment.pages.inc | |
| parent | ecf40c67a9e24fea52ec4d83bc723a27143866e6 (diff) | |
| download | brdo-93a96563fb44ca5683b4ae809972b6ea1eacf99d.tar.gz brdo-93a96563fb44ca5683b4ae809972b6ea1eacf99d.tar.bz2 | |
Issue #1532682 by TravisCarden: Fix return value docs for comment_reply function
Diffstat (limited to 'modules/comment/comment.pages.inc')
| -rw-r--r-- | modules/comment/comment.pages.inc | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/modules/comment/comment.pages.inc b/modules/comment/comment.pages.inc index 7e88bffcb..482e3f2ff 100644 --- a/modules/comment/comment.pages.inc +++ b/modules/comment/comment.pages.inc @@ -23,8 +23,12 @@ * Some comments are replies to other comments. In those cases, $pid is the parent * comment's cid. * - * @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, $pid = NULL) { // Set the breadcrumb trail. |