diff options
Diffstat (limited to 'includes/pager.inc')
| -rw-r--r-- | includes/pager.inc | 34 |
1 files changed, 8 insertions, 26 deletions
diff --git a/includes/pager.inc b/includes/pager.inc index 7430cfe8c..a33087c64 100644 --- a/includes/pager.inc +++ b/includes/pager.inc @@ -186,11 +186,11 @@ function pager_get_query_parameters() { } /** - * 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. - * Format a list of nearby pages with additional query results. + * retrieve a pager control so that users can view other results. Format a list + * of nearby pages with additional query results. * * @param $variables * An associative array containing: @@ -201,9 +201,6 @@ function pager_get_query_parameters() { * the pager links. * - quantity: The number of pages in the list. * - * @return - * An HTML string that generates the query pager. - * * @ingroup themeable */ function theme_pager($variables) { @@ -321,7 +318,7 @@ function theme_pager($variables) { */ /** - * Format a "first page" link. + * Returns HTML for the "first page" link in a query pager. * * @param $variables * An associative array containing: @@ -331,9 +328,6 @@ function theme_pager($variables) { * - parameters: An associative array of query string parameters to append to * the pager links. * - * @return - * An HTML string that generates this piece of the query pager. - * * @ingroup themeable */ function theme_pager_first($variables) { @@ -352,7 +346,7 @@ function theme_pager_first($variables) { } /** - * Format a "previous page" link. + * Returns HTML for the "previous page" link in a query pager. * * @param $variables * An associative array containing: @@ -363,9 +357,6 @@ function theme_pager_first($variables) { * - parameters: An associative array of query string parameters to append to * the pager links. * - * @return - * An HTML string that generates this piece of the query pager. - * * @ingroup themeable */ function theme_pager_previous($variables) { @@ -394,7 +385,7 @@ function theme_pager_previous($variables) { } /** - * Format a "next page" link. + * Returns HTML for the "next page" link in a query pager. * * @param $variables * An associative array containing: @@ -405,9 +396,6 @@ function theme_pager_previous($variables) { * - parameters: An associative array of query string parameters to append to * the pager links. * - * @return - * An HTML string that generates this piece of the query pager. - * * @ingroup themeable */ function theme_pager_next($variables) { @@ -435,7 +423,7 @@ function theme_pager_next($variables) { } /** - * Format a "last page" link. + * Returns HTML for the "last page" link in query pager. * * @param $variables * An associative array containing: @@ -445,9 +433,6 @@ function theme_pager_next($variables) { * - parameters: An associative array of query string parameters to append to * the pager links. * - * @return - * An HTML string that generates this piece of the query pager. - * * @ingroup themeable */ function theme_pager_last($variables) { @@ -467,7 +452,7 @@ function theme_pager_last($variables) { /** - * Format a link to a specific query result page. + * Returns HTML for a link to a specific query result page. * * @param $variables * An associative array containing: @@ -479,9 +464,6 @@ function theme_pager_last($variables) { * - attributes: An associative array of HTML attributes to apply to a pager * anchor tag. * - * @return - * An HTML string that generates the link. - * * @ingroup themeable */ function theme_pager_link($variables) { |