diff options
| author | Dries Buytaert <dries@buytaert.net> | 2010-04-13 15:23:03 +0000 |
|---|---|---|
| committer | Dries Buytaert <dries@buytaert.net> | 2010-04-13 15:23:03 +0000 |
| commit | 3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d (patch) | |
| tree | 4bd9c67db94feb06249cc2727dd3a5e935f58e12 /modules/aggregator | |
| parent | f8e14898d636ceae44a9980105da903f57d2deef (diff) | |
| download | brdo-3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d.tar.gz brdo-3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d.tar.bz2 | |
- Patch #716496 by JohnAlbin: documentation updates for theme functions.
Diffstat (limited to 'modules/aggregator')
| -rw-r--r-- | modules/aggregator/aggregator.module | 4 | ||||
| -rw-r--r-- | modules/aggregator/aggregator.pages.inc | 14 |
2 files changed, 9 insertions, 9 deletions
diff --git a/modules/aggregator/aggregator.module b/modules/aggregator/aggregator.module index d7343050e..b6cf40c3b 100644 --- a/modules/aggregator/aggregator.module +++ b/modules/aggregator/aggregator.module @@ -703,15 +703,13 @@ function aggregator_category_load($cid) { } /** - * Format an individual feed item for display in the block. + * Returns HTML for an individual feed item for display in the block. * * @param $variables * An associative array containing: * - item: The item to be displayed. * - feed: Not used. * - * @return - * The item HTML. * @ingroup themeable */ function theme_aggregator_block_item($variables) { diff --git a/modules/aggregator/aggregator.pages.inc b/modules/aggregator/aggregator.pages.inc index f8eb047af..1613a501a 100644 --- a/modules/aggregator/aggregator.pages.inc +++ b/modules/aggregator/aggregator.pages.inc @@ -234,14 +234,12 @@ function aggregator_categorize_items_submit($form, &$form_state) { } /** - * Theme the page list form for assigning categories. + * Returns HTML for the aggregator page list form for assigning categories. * * @param $variables * An associative array containing: - * - form: An associative array containing the structure of the form. + * - form: A render element representing the form. * - * @return - * The output HTML. * @ingroup themeable */ function theme_aggregator_categorize_items($variables) { @@ -371,13 +369,15 @@ function aggregator_page_rss() { } /** - * Theme the RSS output. + * Prints the RSS page for a feed. * * @param $variables * An associative array containing: * - feeds: An array of the feeds to theme. * - category: A common category, if any, for all the feeds. * + * @return void + * * @ingroup themeable */ function theme_aggregator_page_rss($variables) { @@ -437,12 +437,14 @@ function aggregator_page_opml($cid = NULL) { } /** - * Theme the OPML feed output. + * Prints the OPML page for a feed. * * @param $variables * An associative array containing: * - feeds: An array of the feeds to theme. * + * @return void + * * @ingroup themeable */ function theme_aggregator_page_opml($variables) { |