summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--includes/pager.inc19
1 files changed, 12 insertions, 7 deletions
diff --git a/includes/pager.inc b/includes/pager.inc
index 8d51439..c0b6896 100644
--- a/includes/pager.inc
+++ b/includes/pager.inc
@@ -90,7 +90,7 @@ function pager_get_querystring() {
}
/**
- * Format a query pager.
+ * Returns HTML for a query pager.
*
* Menu callbacks that display paged query results should call theme('pager') to
* retrieve a pager control so that users can view other results.
@@ -223,7 +223,7 @@ function theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = a
*/
/**
- * Format a "first page" link.
+ * Returns HTML for a "first page" link.
*
* @param $text
* The name (or image) of the link.
@@ -251,7 +251,7 @@ function theme_pager_first($text, $limit, $element = 0, $parameters = array()) {
}
/**
- * Format a "previous page" link.
+ * Returns HTML for a "previous page" link.
*
* @param $text
* The name (or image) of the link.
@@ -290,7 +290,7 @@ function theme_pager_previous($text, $limit, $element = 0, $interval = 1, $param
}
/**
- * Format a "next page" link.
+ * Returns HTML for a "next page" link.
*
* @param $text
* The name (or image) of the link.
@@ -328,7 +328,7 @@ function theme_pager_next($text, $limit, $element = 0, $interval = 1, $parameter
}
/**
- * Format a "last page" link.
+ * Returns HTML for a "last page" link.
*
* @param $text
* The name (or image) of the link.
@@ -357,8 +357,13 @@ function theme_pager_last($text, $limit, $element = 0, $parameters = array()) {
/**
- * Format a link to a specific query result page.
+ * Returns HTML for a link to a specific query result page.
*
+ * @param $text
+ * The link text. Also used to figure out the title attribute of the link,
+ * if it is not provided in $attributes['title']; in this case, $text must
+ * be one of the standard pager link text strings that would be generated by
+ * the pager theme functions, such as a number or t('« first').
* @param $page_new
* The first result to display on the linked page.
* @param $element
@@ -366,7 +371,7 @@ function theme_pager_last($text, $limit, $element = 0, $parameters = array()) {
* @param $parameters
* An associative array of query string parameters to append to the pager link.
* @param $attributes
- * An associative array of HTML attributes to apply to a pager anchor tag.
+ * An associative array of HTML attributes to apply to the pager link.
* @return
* An HTML string that generates the link.
*