From 2c3cba3b6e8442a12b02f626d2151716b9aad8ae Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Thu, 23 Aug 2012 07:37:20 -0700
Subject: Issue #1722244 by Albert Volkman, edb: Add return docs to
 drupal_get_destination function

---
 includes/common.inc | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'includes')

diff --git a/includes/common.inc b/includes/common.inc
index efb7926a3..39ed04e8c 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -505,6 +505,12 @@ function drupal_http_build_query(array $query, $parent = '') {
  * previous request, that destination is returned. As such, a destination can
  * persist across multiple pages.
  *
+ * @return
+ *   An associative array containing the key:
+ *   - destination: The path provided via the destination query string or, if
+ *     not available, the current path.
+ *
+ * @see current_path()
  * @see drupal_goto()
  */
 function drupal_get_destination() {
-- 
cgit v1.2.3