Issue #1722244 by Albert Volkman, edb: Add return docs for drupal_get_destination...
authorJennifer Hodgdon
Mon, 17 Sep 2012 19:09:30 +0000 (12:09 -0700)
committerJennifer Hodgdon
Mon, 17 Sep 2012 19:09:30 +0000 (12:09 -0700)
includes/common.inc

index 8ae0517..24d7405 100644 (file)
@@ -510,6 +510,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() {