From 12393a4d128b4a890df76fd7aba6dd9e27db80f1 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Mon, 13 Oct 2008 12:31:43 +0000
Subject: - Patch #320000 by lilou: unify doxygen @file documentation in tpl.

---
 modules/book/book-all-books-block.tpl.php    | 2 +-
 modules/forum/forum-icon.tpl.php             | 4 ++--
 modules/forum/forum-list.tpl.php             | 2 +-
 modules/forum/forum-submitted.tpl.php        | 2 +-
 modules/forum/forum-topic-list.tpl.php       | 4 ++--
 modules/forum/forum-topic-navigation.tpl.php | 2 +-
 modules/forum/forums.tpl.php                 | 2 +-
 modules/node/node.tpl.php                    | 5 ++---
 modules/poll/poll-bar-block.tpl.php          | 5 +++--
 modules/poll/poll-bar.tpl.php                | 5 +++--
 modules/poll/poll-results-block.tpl.php      | 4 ++--
 modules/poll/poll-results.tpl.php            | 4 ++--
 modules/poll/poll-vote.tpl.php               | 4 ++--
 modules/profile/profile-block.tpl.php        | 2 +-
 modules/profile/profile-listing.tpl.php      | 2 +-
 modules/profile/profile-wrapper.tpl.php      | 2 +-
 modules/search/search-block-form.tpl.php     | 5 +++--
 modules/search/search-result.tpl.php         | 2 +-
 modules/search/search-results.tpl.php        | 2 +-
 modules/search/search-theme-form.tpl.php     | 2 +-
 modules/system/block.tpl.php                 | 5 ++---
 modules/system/box.tpl.php                   | 5 ++---
 modules/system/maintenance-page.tpl.php      | 6 ++----
 modules/system/page.tpl.php                  | 5 ++---
 modules/user/user-picture.tpl.php            | 2 +-
 modules/user/user-profile-category.tpl.php   | 2 +-
 modules/user/user-profile-item.tpl.php       | 2 +-
 modules/user/user-profile.tpl.php            | 2 +-
 28 files changed, 44 insertions(+), 47 deletions(-)

(limited to 'modules')

diff --git a/modules/book/book-all-books-block.tpl.php b/modules/book/book-all-books-block.tpl.php
index e3c2d2c89..3f4eb2259 100644
--- a/modules/book/book-all-books-block.tpl.php
+++ b/modules/book/book-all-books-block.tpl.php
@@ -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.
diff --git a/modules/forum/forum-icon.tpl.php b/modules/forum/forum-icon.tpl.php
index 0139063cb..1165c7930 100644
--- a/modules/forum/forum-icon.tpl.php
+++ b/modules/forum/forum-icon.tpl.php
@@ -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.
diff --git a/modules/forum/forum-list.tpl.php b/modules/forum/forum-list.tpl.php
index 46dbd5ed9..5d8f18cec 100644
--- a/modules/forum/forum-list.tpl.php
+++ b/modules/forum/forum-list.tpl.php
@@ -2,7 +2,7 @@
 // $Id$
 
 /**
- * @file forum-list.tpl.php
+ * @file
  * Default theme implementation to display a list of forums and containers.
  *
  * Available variables:
diff --git a/modules/forum/forum-submitted.tpl.php b/modules/forum/forum-submitted.tpl.php
index dc3a6e4a3..8695e3464 100644
--- a/modules/forum/forum-submitted.tpl.php
+++ b/modules/forum/forum-submitted.tpl.php
@@ -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.
  *
diff --git a/modules/forum/forum-topic-list.tpl.php b/modules/forum/forum-topic-list.tpl.php
index 5995850e2..6613ad7d5 100644
--- a/modules/forum/forum-topic-list.tpl.php
+++ b/modules/forum/forum-topic-list.tpl.php
@@ -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
diff --git a/modules/forum/forum-topic-navigation.tpl.php b/modules/forum/forum-topic-navigation.tpl.php
index 92b2ff5de..362c2410b 100644
--- a/modules/forum/forum-topic-navigation.tpl.php
+++ b/modules/forum/forum-topic-navigation.tpl.php
@@ -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.
  *
diff --git a/modules/forum/forums.tpl.php b/modules/forum/forums.tpl.php
index 7c2dbc84a..d9a0506c6 100644
--- a/modules/forum/forums.tpl.php
+++ b/modules/forum/forums.tpl.php
@@ -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.
  *
diff --git a/modules/node/node.tpl.php b/modules/node/node.tpl.php
index 009153023..9a92d5a1c 100644
--- a/modules/node/node.tpl.php
+++ b/modules/node/node.tpl.php
@@ -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.
diff --git a/modules/poll/poll-bar-block.tpl.php b/modules/poll/poll-bar-block.tpl.php
index ca744d620..6de5e7737 100644
--- a/modules/poll/poll-bar-block.tpl.php
+++ b/modules/poll/poll-bar-block.tpl.php
@@ -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.
diff --git a/modules/poll/poll-bar.tpl.php b/modules/poll/poll-bar.tpl.php
index 54a79997c..1907ba1f2 100644
--- a/modules/poll/poll-bar.tpl.php
+++ b/modules/poll/poll-bar.tpl.php
@@ -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.
diff --git a/modules/poll/poll-results-block.tpl.php b/modules/poll/poll-results-block.tpl.php
index 0d2d62d3f..a0598c4a9 100644
--- a/modules/poll/poll-results-block.tpl.php
+++ b/modules/poll/poll-results-block.tpl.php
@@ -1,8 +1,8 @@
 <?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.
diff --git a/modules/poll/poll-results.tpl.php b/modules/poll/poll-results.tpl.php
index 670a50af5..cf89768ed 100644
--- a/modules/poll/poll-results.tpl.php
+++ b/modules/poll/poll-results.tpl.php
@@ -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.
diff --git a/modules/poll/poll-vote.tpl.php b/modules/poll/poll-vote.tpl.php
index 5b4a73668..8c3a46636 100644
--- a/modules/poll/poll-vote.tpl.php
+++ b/modules/poll/poll-vote.tpl.php
@@ -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.
diff --git a/modules/profile/profile-block.tpl.php b/modules/profile/profile-block.tpl.php
index 31bf5d140..d84633494 100644
--- a/modules/profile/profile-block.tpl.php
+++ b/modules/profile/profile-block.tpl.php
@@ -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.
  *
diff --git a/modules/profile/profile-listing.tpl.php b/modules/profile/profile-listing.tpl.php
index 59e2c9710..07c111b5d 100644
--- a/modules/profile/profile-listing.tpl.php
+++ b/modules/profile/profile-listing.tpl.php
@@ -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.
  *
diff --git a/modules/profile/profile-wrapper.tpl.php b/modules/profile/profile-wrapper.tpl.php
index 2030c2a49..52de80279 100644
--- a/modules/profile/profile-wrapper.tpl.php
+++ b/modules/profile/profile-wrapper.tpl.php
@@ -2,7 +2,7 @@
 // $Id$
 
 /**
- * @file profile-wrapper.tpl.php
+ * @file
  * Default theme implementation for wrapping member listings and their
  * profiles.
  *
diff --git a/modules/search/search-block-form.tpl.php b/modules/search/search-block-form.tpl.php
index a464765a9..f483ddd7a 100644
--- a/modules/search/search-block-form.tpl.php
+++ b/modules/search/search-block-form.tpl.php
@@ -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.
diff --git a/modules/search/search-result.tpl.php b/modules/search/search-result.tpl.php
index 1f9f96eb1..247595fc5 100644
--- a/modules/search/search-result.tpl.php
+++ b/modules/search/search-result.tpl.php
@@ -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
diff --git a/modules/search/search-results.tpl.php b/modules/search/search-results.tpl.php
index 709245b26..f87797ae6 100644
--- a/modules/search/search-results.tpl.php
+++ b/modules/search/search-results.tpl.php
@@ -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
diff --git a/modules/search/search-theme-form.tpl.php b/modules/search/search-theme-form.tpl.php
index 541b498b4..60bc3e45d 100644
--- a/modules/search/search-theme-form.tpl.php
+++ b/modules/search/search-theme-form.tpl.php
@@ -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.
  *
diff --git a/modules/system/block.tpl.php b/modules/system/block.tpl.php
index 8ca0f2ba4..459a94034 100644
--- a/modules/system/block.tpl.php
+++ b/modules/system/block.tpl.php
@@ -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.
diff --git a/modules/system/box.tpl.php b/modules/system/box.tpl.php
index 796c3dcfe..b69a21f9f 100644
--- a/modules/system/box.tpl.php
+++ b/modules/system/box.tpl.php
@@ -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.
diff --git a/modules/system/maintenance-page.tpl.php b/modules/system/maintenance-page.tpl.php
index 1c8b4b329..3a6139306 100644
--- a/modules/system/maintenance-page.tpl.php
+++ b/modules/system/maintenance-page.tpl.php
@@ -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()
  */
diff --git a/modules/system/page.tpl.php b/modules/system/page.tpl.php
index cbbf01f72..2a38a7d5d 100644
--- a/modules/system/page.tpl.php
+++ b/modules/system/page.tpl.php
@@ -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:
  *
diff --git a/modules/user/user-picture.tpl.php b/modules/user/user-picture.tpl.php
index ae07680f5..a194fc447 100644
--- a/modules/user/user-picture.tpl.php
+++ b/modules/user/user-picture.tpl.php
@@ -2,7 +2,7 @@
 // $Id$
 
 /**
- * @file user-picture.tpl.php
+ * @file
  * Default theme implementation to present an picture configured for the
  * user's account.
  *
diff --git a/modules/user/user-profile-category.tpl.php b/modules/user/user-profile-category.tpl.php
index 55946643a..4ad038ba2 100644
--- a/modules/user/user-profile-category.tpl.php
+++ b/modules/user/user-profile-category.tpl.php
@@ -2,7 +2,7 @@
 // $Id$
 
 /**
- * @file user-profile-category.tpl.php
+ * @file
  * Default theme implementation to present profile categories (groups of
  * profile items).
  *
diff --git a/modules/user/user-profile-item.tpl.php b/modules/user/user-profile-item.tpl.php
index e51a4b114..2f7236822 100644
--- a/modules/user/user-profile-item.tpl.php
+++ b/modules/user/user-profile-item.tpl.php
@@ -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).
  *
diff --git a/modules/user/user-profile.tpl.php b/modules/user/user-profile.tpl.php
index 14a5bda0d..73bf250d6 100644
--- a/modules/user/user-profile.tpl.php
+++ b/modules/user/user-profile.tpl.php
@@ -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,
-- 
cgit v1.2.3