Commit 12393a4d authored by Dries's avatar Dries

- Patch #320000 by lilou: unify doxygen @file documentation in tpl.

parent 659c4867
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file book-all-books-block.tpl.php
* @file
* Default theme implementation for rendering book outlines within a block.
* This template is used only when the block is configured to "show block on
* all pages" which presents Multiple independent books on all pages.
......
......@@ -2,8 +2,8 @@
// $Id$
/**
* @file forum-icon.tpl.php
* Display an appropriate icon for a forum post.
* @file
* Default theme implementation to display an appropriate icon for a forum post.
*
* Available variables:
* - $new_posts: Indicates whether or not the topic contains new posts.
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file forum-list.tpl.php
* @file
* Default theme implementation to display a list of forums and containers.
*
* Available variables:
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file forum-submitted.tpl.php
* @file
* Default theme implementation to format a simple string indicated when and
* by whom a topic was submitted.
*
......
......@@ -2,8 +2,8 @@
// $Id$
/**
* @file forum-topic-list.tpl.php
* Theme implementation to display a list of forum topics.
* @file
* Default theme implementation to display a list of forum topics.
*
* Available variables:
* - $header: The table header. This is pre-generated with click-sorting
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file forum-topic-navigation.tpl.php
* @file
* Default theme implementation to display the topic navigation string at the
* bottom of all forum topics.
*
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file forums.tpl.php
* @file
* Default theme implementation to display a forum which may contain forum
* containers as well as forum topics.
*
......
......@@ -2,9 +2,8 @@
// $Id$
/**
* @file node.tpl.php
*
* Theme implementation to display a node.
* @file
* Default theme implementation to display a node.
*
* Available variables:
* - $title: the (sanitized) title of the node.
......
......@@ -2,8 +2,9 @@
// $Id$
/**
* @file poll-bar-block.tpl.php
* Display the bar for a single choice in a poll
* @file
* Default theme implementation to display the bar for a single choice in a
* poll.
*
* Variables available:
* - $title: The title of the poll.
......
......@@ -2,8 +2,9 @@
// $Id$
/**
* @file poll-bar.tpl.php
* Display the bar for a single choice in a poll
* @file
* Default theme implementation to display the bar for a single choice in a
* poll.
*
* Variables available:
* - $title: The title of the poll.
......
<?php
// $Id$
/**
* @file poll-results-block.tpl.php
* Display the poll results in a block.
* @file
* Default theme implementation to display the poll results in a block.
*
* Variables available:
* - $title: The title of the poll.
......
......@@ -2,8 +2,8 @@
// $Id$
/**
* @file poll-results-block.tpl.php
* Display the poll results in a block.
* @file
* Default theme implementation to display the poll results in a block.
*
* Variables available:
* - $title: The title of the poll.
......
......@@ -2,8 +2,8 @@
// $Id$
/**
* @file poll-vote.tpl.php
* Voting form for a poll.
* @file
* Default theme implementation to display voting form for a poll.
*
* - $choice: The radio buttons for the choices in the poll.
* - $title: The title of the poll.
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file profile-block.tpl.php
* @file
* Default theme implementation for displaying a users profile within a
* block. It only shows in relation to a node displayed as a full page.
*
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file profile-listing.tpl.php
* @file
* Default theme implementation for displaying a user and their profile data
* for member listing pages.
*
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file profile-wrapper.tpl.php
* @file
* Default theme implementation for wrapping member listings and their
* profiles.
*
......
......@@ -2,8 +2,9 @@
// $Id$
/**
* @file search-block-form.tpl.php
* Default theme implementation for displaying a search form within a block region.
* @file
* Default theme implementation for displaying a search form within a block
* region.
*
* Available variables:
* - $search_form: The complete search form ready for print.
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file search-result.tpl.php
* @file
* Default theme implementation for displaying a single search result.
*
* This template renders a single search result and is collected into
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file search-results.tpl.php
* @file
* Default theme implementation for displaying search results.
*
* This template collects each invocation of theme_search_result(). This and
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file search-theme-form.tpl.php
* @file
* Default theme implementation for displaying a search form directly into the
* theme layout. Not to be confused with the search block or the search page.
*
......
......@@ -2,9 +2,8 @@
// $Id$
/**
* @file block.tpl.php
*
* Theme implementation to display a block.
* @file
* Default theme implementation to display a block.
*
* Available variables:
* - $block->subject: Block title.
......
......@@ -2,9 +2,8 @@
// $Id$
/**
* @file box.tpl.php
*
* Theme implementation to display a box.
* @file
* Default theme implementation to display a box.
*
* Available variables:
* - $title: Box title.
......
......@@ -2,14 +2,12 @@
// $Id$
/**
* @file maintenance-page.tpl.php
*
* Theme implementation to display a single Drupal page while offline.
* @file
* Default theme implementation to display a single Drupal page while offline.
*
* All the available variables are mirrored in page.tpl.php. Some may be left
* blank but they are provided for consistency.
*
*
* @see template_preprocess()
* @see template_preprocess_maintenance_page()
*/
......
......@@ -2,9 +2,8 @@
// $Id$
/**
* @file page.tpl.php
*
* Theme implementation to display a single Drupal page.
* @file
* Default theme implementation to display a single Drupal page.
*
* Available variables:
*
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file user-picture.tpl.php
* @file
* Default theme implementation to present an picture configured for the
* user's account.
*
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file user-profile-category.tpl.php
* @file
* Default theme implementation to present profile categories (groups of
* profile items).
*
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file user-profile-item.tpl.php
* @file
* Default theme implementation to present profile items (values from user
* account profile fields or modules).
*
......
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file user-profile.tpl.php
* @file
* Default theme implementation to present all user profile data.
*
* This template is used when viewing a registered member's profile page,
......
......@@ -2,7 +2,8 @@
// $Id$
/**
* @file maintenance-page.tpl.php
* @file
* Override of the default maintenance page.
*
* This is an override of the default maintenance page. Used for Garland and
* Minnelli, this file should not be moved or modified since the installation
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment