commit 117ac7565d6ab53783337901020fce1427ed81b2 Author: James Wilson Date: Mon Oct 15 00:33:42 2012 -0400 Twig docblock cleanup, for existing twig templates. diff --git a/core/themes/stark/templates/aggregator/aggregator-feed-source.html.twig b/core/themes/stark/templates/aggregator/aggregator-feed-source.html.twig index 3b8b06c..5b3e266 100644 --- a/core/themes/stark/templates/aggregator/aggregator-feed-source.html.twig +++ b/core/themes/stark/templates/aggregator/aggregator-feed-source.html.twig @@ -14,8 +14,9 @@ * - source_url: URL to the feed source. * - last_checked: How long ago the feed was checked locally. * - * @see template_preprocess() - * @see template_preprocess_aggregator_feed_source() + * @see template_preprocess + * @see template_preprocess_aggregator_feed_source + * @see theme_feed_icon * * @ingroup themeable */ diff --git a/core/themes/stark/templates/aggregator/aggregator-item.html.twig b/core/themes/stark/templates/aggregator/aggregator-item.html.twig index c308aee..560d923 100644 --- a/core/themes/stark/templates/aggregator/aggregator-item.html.twig +++ b/core/themes/stark/templates/aggregator/aggregator-item.html.twig @@ -1,8 +1,7 @@ {# /** * @file - * Default theme implementation to format an individual feed item for display - * on the aggregator page. + * Default theme implementation to present a feed in an aggregator page. * * Available variables: * - feed_url: URL to the originating feed item. @@ -13,8 +12,8 @@ * - content: Feed item content. * - categories: Linked categories assigned to the feed. * - * @see template_preprocess() - * @see template_preprocess_aggregator_item() + * @see template_preprocess + * @see template_preprocess_aggregator_item * * @ingroup themeable */ diff --git a/core/themes/stark/templates/aggregator/aggregator-summary-items.html.twig b/core/themes/stark/templates/aggregator/aggregator-summary-items.html.twig index e2c40ef..9957e34 100644 --- a/core/themes/stark/templates/aggregator/aggregator-summary-items.html.twig +++ b/core/themes/stark/templates/aggregator/aggregator-summary-items.html.twig @@ -11,8 +11,8 @@ * theme_item_list(). * - source_url: URL to the local source or category. * - * @see template_preprocess() - * @see template_preprocess_aggregator_summary_items() + * @see template_preprocess + * @see template_preprocess_aggregator_summary_items * * @ingroup themeable */ diff --git a/core/themes/stark/templates/aggregator/aggregator-wrapper.html.twig b/core/themes/stark/templates/aggregator/aggregator-wrapper.html.twig index e4c52a0..b1bb483 100644 --- a/core/themes/stark/templates/aggregator/aggregator-wrapper.html.twig +++ b/core/themes/stark/templates/aggregator/aggregator-wrapper.html.twig @@ -7,8 +7,9 @@ * - content: All aggregator content. * - page: Pager links rendered through theme_pager(). * - * @see template_preprocess() - * @see template_preprocess_aggregator_wrapper() + * @see template_preprocess + * @see template_preprocess_aggregator_wrapper + * @see theme_pager * * @ingroup themeable */ diff --git a/core/themes/stark/templates/block/block.html.twig b/core/themes/stark/templates/block/block.html.twig index 2331308..896d2a7 100644 --- a/core/themes/stark/templates/block/block.html.twig +++ b/core/themes/stark/templates/block/block.html.twig @@ -6,8 +6,8 @@ * Available variables: * - title: Block title. * - contents: The contents of this block. - * - attributes: Remaining HTML attributes for the containing element. - * - attributes.id: A valid HTML ID and guaranteed unique. + * - attributes: Remaining html attributes for the containing element. + * - attributes.id: A valid html ID and guaranteed unique. * - attributes.class: Classes that can be used to style contextually through * CSS. These can be manipulated through from preprocess functions. The * default values can be one or more of the following: @@ -18,7 +18,7 @@ * - block.module: Module that generated the block. * - block.delta: An ID for the block, unique within each module. * - block.region: The block region embedding the current block. - * + * * Helper variables: * - block_id: Counter dependent on each block region. * - id: Same output as $block_id but independent of any block region. @@ -26,13 +26,13 @@ * - logged_in: Flags true when the current user is a logged-in member. * - is_admin: Flags true when the current user is an administrator. * - * @see template_preprocess() - * @see template_preprocess_container() + * @TODO update include path once http://drupal.org/node/1777532 is resolved. + * + * @see template_preprocess + * @see template_preprocess_container * * @ingroup themeable */ - - @TODO - update this include path once http://drupal.org/node/1777532 is resolved. #}
{% include 'core/themes/stark/templates/title.html.twig' %} diff --git a/core/themes/stark/templates/book/book-all-books-block.html.twig b/core/themes/stark/templates/book/book-all-books-block.html.twig index ebc1284..14e665d 100644 --- a/core/themes/stark/templates/book/book-all-books-block.html.twig +++ b/core/themes/stark/templates/book/book-all-books-block.html.twig @@ -9,9 +9,10 @@ * Available variables: * - book_menus: Book outlines. * - book_id: the parent book ID. - * - menu: @TOTO + * - menu: @TODO * - * @see template_preprocess_book_all_books_block() + * @see template_preprocess + * @see template_preprocess_book_all_books_block * * @ingroup themeable */ @@ -20,4 +21,4 @@ -{% endfor %} \ No newline at end of file +{% endfor %} diff --git a/core/themes/stark/templates/book/book-export-html.html.twig b/core/themes/stark/templates/book/book-export-html.html.twig index c327bc7..38a42e8 100755 --- a/core/themes/stark/templates/book/book-export-html.html.twig +++ b/core/themes/stark/templates/book/book-export-html.html.twig @@ -1,19 +1,22 @@ {# - @file - Default theme implementation for printed version of book outline. - * - Available variables: - - title: Top level node title. - - head: Header tags. - - language: Language object. - - language_rtl: TRUE or FALSE depending on right to left language scripts. - - base_url: URL to home page. - - contents: Nodes within the current outline rendered through - book-node-export-html.tpl.php. - * - @see template_preprocess_book_export_html() - * - @ingroup themeable +/** + * @file + * Default theme implementation for printed version of book outline. + * + * Available variables: + * - title: Top level node title. + * - head: Header tags. + * - language: Language object. + * - language_rtl: TRUE or FALSE depending on right to left language scripts. + * - base_url: URL to home page. + * - contents: Nodes within the current outline rendered through + * book-node-export-html.html.twig. + * + * @see template_preprocess + * @see template_preprocess_book_export_html + * + * @ingroup themeable + */ #} diff --git a/core/themes/stark/templates/book/book-navigation.html.twig b/core/themes/stark/templates/book/book-navigation.html.twig index b951c42..663f726 100644 --- a/core/themes/stark/templates/book/book-navigation.html.twig +++ b/core/themes/stark/templates/book/book-navigation.html.twig @@ -26,7 +26,8 @@ * - book_title: The book/node title of the current outline being viewed. * Provided as an option. Not used by default. * - * @see template_preprocess_book_navigation() + * @see template_preprocess + * @see template_preprocess_book_navigation * * @ingroup themeable */ diff --git a/core/themes/stark/templates/book/book-node-export-html.html.twig b/core/themes/stark/templates/book/book-node-export-html.html.twig index ce3578c..bb95385 100644 --- a/core/themes/stark/templates/book/book-node-export-html.html.twig +++ b/core/themes/stark/templates/book/book-node-export-html.html.twig @@ -13,7 +13,8 @@ * - content: Node content. * - children: All the child nodes recursively rendered through this file. * - * @see template_preprocess_book_node_export_html() + * @see template_preprocess + * @see template_preprocess_book_node_export_html * * @ingroup themeable */ @@ -22,4 +23,4 @@

{{ title }}

{{ content }} {{ children }} - \ No newline at end of file + diff --git a/core/themes/stark/templates/comment/comment-block.html.twig b/core/themes/stark/templates/comment/comment-block.html.twig index 1f6d9e6..cacfd90 100755 --- a/core/themes/stark/templates/comment/comment-block.html.twig +++ b/core/themes/stark/templates/comment/comment-block.html.twig @@ -1,10 +1,15 @@ {# /** * @file - * Returns HTML for a list of recent comments. + * Default theme implementation for a list of recent comments. * * Available variables: * - items: A list of recent comments. + * + * @see template_preprocess + * @see template_preprocess_comment_block + * + * @ingroup themable */ #} {% if items.count > 0 %} @@ -12,4 +17,3 @@ {% else %} {{ 'No comments available'|t }} {% endif %} - diff --git a/core/themes/stark/templates/comment/comment-wrapper.html.twig b/core/themes/stark/templates/comment/comment-wrapper.html.twig index 9acc360..7407eca 100644 --- a/core/themes/stark/templates/comment/comment-wrapper.html.twig +++ b/core/themes/stark/templates/comment/comment-wrapper.html.twig @@ -1,32 +1,32 @@ {# /** * @file - * Provides an HTML container for comments. + * Provides an html container for comments. * * Available variables: * - content: The array of content-related elements for the node. Use - * render($content) to print them all, or - * print a subset such as render($content['comment_form']). - * - attributes: Remaining HTML attributes for the containing element. - * It includes the 'class' information, which includes: - * - comment-wrapper: The current template type, i.e., "theming hook". - * - title_prefix (array): An array containing additional output populated by - * modules, intended to be displayed in front of the main title tag that - * appears in the template. - * - title_suffix (array): An array containing additional output populated by - * modules, intended to be displayed after the main title tag that appears in - * the template. + * render($content) to print them all, or print a subset such as + * render($content['comment_form']). + * - attributes: Remaining html attributes for the containing element. + * It includes the 'class' information, which includes: + * - comment-wrapper: The current template type, i.e., "theming hook". + * - title_prefix: An array containing additional output populated by + * modules, intended to be displayed in front of the main title tag that + * appears in the template. + * - title_suffix: An array containing additional output populated by + * modules, intended to be displayed after the main title tag that + * appears in the template. * * The following variables are provided for contextual information. - * - $node: Node entity the comments are attached to. - * The constants below the variables show the possible values and should be - * used for comparison. - * - $display_mode - * - COMMENT_MODE_FLAT - * - COMMENT_MODE_THREADED + * - node: The node entity to which the comments belong. + * The constants below the variables show the possible values and should be + * used for comparison. + * - display_mode + * - COMMENT_MODE_FLAT + * - COMMENT_MODE_THREADED * - * @see template_preprocess_comment_wrapper() - * @see theme_comment_wrapper() + * @see template_preprocess + * @see template_preprocess_comment_wrapper */ #}
diff --git a/core/themes/stark/templates/comment/comment.html.twig b/core/themes/stark/templates/comment/comment.html.twig index 089b60b..0b13f73 100644 --- a/core/themes/stark/templates/comment/comment.html.twig +++ b/core/themes/stark/templates/comment/comment.html.twig @@ -47,8 +47,8 @@ * - comment: Full comment object. * - node: Node entity the comments are attached to. * - * @see template_preprocess() - * @see template_preprocess_comment() + * @see template_preprocess + * @see template_preprocess_comment * * @ingroup themeable */ diff --git a/core/themes/stark/templates/container.twig.txt b/core/themes/stark/templates/container.twig.txt index 85e0b20..86e2e1a 100644 --- a/core/themes/stark/templates/container.twig.txt +++ b/core/themes/stark/templates/container.twig.txt @@ -7,21 +7,21 @@ * - title: Title. * - title.prefix: Additional output populated by modules, intended to be * displayed in front of the main title tag that appears in the template. - * - title.suffix: Additional output populated by modules, intended to be + * - title.suffix: Additional output populated by modules, intended to be * displayed after the main title tag that appears in the template. - * - title.element: - * - title.attributes: Remaining HTML attributes for the title element. - * - title.attributes.class: Classes that can be used to style contextually through - * CSS. These can be manipulated through from preprocess functions. + * - title.element: + * - title.attributes: Remaining html attributes for the title element. + * - title.attributes.class: Classes that can be used to style contextually + * through CSS. These can be manipulated through from preprocess functions. * - contents: Contents of the box. - * - attributes: Remaining HTML attributes for the containing element. - * - attributes.class: Classes that can be used to style contextually through + * - attributes: Remaining html attributes for the containing element. + * - attributes.class: Classes that can be used to style contextually through * CSS. These can be manipulated through from preprocess functions. * The default values can be one or more of the following: - * @TODO + * @TODO describe default values * - * @see template_preprocess() - * @see template_preprocess_container() + * @see template_preprocess + * @see template_preprocess_container * * @ingroup themeable */ diff --git a/core/themes/stark/templates/field/field.html.twig b/core/themes/stark/templates/field/field.html.twig index 0db4294..a1c3ff3 100644 --- a/core/themes/stark/templates/field/field.html.twig +++ b/core/themes/stark/templates/field/field.html.twig @@ -1,20 +1,21 @@ {# /** * @file - * Returns HTML for a field. + * Default theme implementation for a field. * * Available variables: - * - label_hidden: A boolean indicating to show or hide the field label. - * - title_attributes: A string containing the attributes for the title. - * - label: The label for the field. - * - content_attributes: A string containing the attributes for the content's div. - * - items: An array of field items. - * - item_attributes: An array of attributes for each item. - * - classes: A string containing the classes for the wrapping div. + * - label_hidden: A boolean indicating to show or hide the field label. + * - title_attributes: A string containing the attributes for the title. + * - label: The label for the field. + * - content_attributes: A string containing the attributes for the content's div. + * - items: An array of field items. + * - item_attributes: An array of attributes for each item. + * - classes: A string containing the classes for the wrapping div. * - * @see template_preprocess_field() - * @see template_process_field() - * @see theme_field() + * @see template_preprocess_field + * @see template_process_field + * + * @ingroup themable */ #}
diff --git a/core/themes/stark/templates/file/file-icon.html.twig b/core/themes/stark/templates/file/file-icon.html.twig index 5c1f917..2279a0c 100755 --- a/core/themes/stark/templates/file/file-icon.html.twig +++ b/core/themes/stark/templates/file/file-icon.html.twig @@ -1,14 +1,16 @@ {# /** - * Returns HTML for an image with an appropriate icon for the given file. + * @file + * Default theme implementation for an image with an appropriate icon for the given file. * - * @param $variables - * An associative array containing: - * - file: A file entity for which to make an icon. - * - icon_directory: (optional) A path to a directory of icons to be used for - * files. Defaults to the value of the "file_icon_directory" variable. + * Available variables: + * - file: A file entity for which to make an icon. + * - icon_directory: (optional) A path to a directory of icons to be used for + * files. Defaults to the value of the "file_icon_directory" variable. + * + * @see template_preprocess * * @ingroup themeable */ #} -{{ mime }} \ No newline at end of file +{{ mime }} diff --git a/core/themes/stark/templates/filter/filter-guidelines.html.twig b/core/themes/stark/templates/filter/filter-guidelines.html.twig index 4e9f367..c2753ac 100755 --- a/core/themes/stark/templates/filter/filter-guidelines.html.twig +++ b/core/themes/stark/templates/filter/filter-guidelines.html.twig @@ -1,17 +1,21 @@ {# /** - * Returns HTML for guidelines for a text format. + * @file + * Default theme implementation for guidelines for a text format. * - * Available variables + * Available variables: * - format: An object representing a text format. - * - attributes: Remaining HTML attributes for the containing element. + * - attributes: Remaining html attributes for the containing element. * - tips: Descriptions and a CSS id in the form of 'module-name/filter-id' * (only used when $long is TRUE) for each filter in one or more text * formats. * + * @TODO update include path once http://drupal.org/node/1777532 is resolved. + * + * @see template_preprocess + * * @ingroup themeable */ - @TODO - update this include path once http://drupal.org/node/1777532 is resolved. #}

{{ format.name }}

diff --git a/core/themes/stark/templates/filter/filter-tips-more-info.html.twig b/core/themes/stark/templates/filter/filter-tips-more-info.html.twig index ce30f34..bc4f2b5 100644 --- a/core/themes/stark/templates/filter/filter-tips-more-info.html.twig +++ b/core/themes/stark/templates/filter/filter-tips-more-info.html.twig @@ -1,9 +1,11 @@ {# /** * @file - * Returns HTML for a link to the more extensive filter tips. + * Default theme implementation for a link to the more extensive filter tips. * - * Available variables + * Available variables: + * + * @see template_preprocess * * @ingroup themeable */ diff --git a/core/themes/stark/templates/filter/filter-tips.html.twig b/core/themes/stark/templates/filter/filter-tips.html.twig index 53fa759..9a6d308 100644 --- a/core/themes/stark/templates/filter/filter-tips.html.twig +++ b/core/themes/stark/templates/filter/filter-tips.html.twig @@ -1,8 +1,9 @@ {# /** - * Returns HTML for a set of filter tips. + * @file + * Default theme implementation for a set of filter tips. * - * Available variables + * Available variables: * - tips: Descriptions and a CSS id in the form of 'module-name/filter-id' * (only used when $long is TRUE) for each filter in one or more text * formats. @@ -11,13 +12,14 @@ * (TRUE), or are in a short format, i.e. suitable to be displayed below a * form element. Defaults to FALSE. * - * @see _filter_tips() + * @TODO reimplement once http://drupal.org/node/1778624 gets resolved. + * + * @see template_preprocess + * @see _filter_tips * * @ingroup themeable */ - @TODO update this craziness once http://drupal.org/node/1778624 gets resolved. #} - {% if multiple %}

{{ 'Text Formats'|t }}

{% endif %} @@ -46,7 +48,7 @@
{% endif %} {% endfor %} - + {% if multiple %}
{% endif %} diff --git a/core/themes/stark/templates/filter/text-format-wrapper.html.twig b/core/themes/stark/templates/filter/text-format-wrapper.html.twig index d63011f..c23d131 100644 --- a/core/themes/stark/templates/filter/text-format-wrapper.html.twig +++ b/core/themes/stark/templates/filter/text-format-wrapper.html.twig @@ -1,15 +1,14 @@ {# /** - * Returns HTML for a text format-enabled form element. - * * @file - * theme_text_format_wrapper($variables) - * - * Default theme implementation to display text. + * Default theme implementation for a text format-enabled form element. * * Available variables: * - element: A form element containing children and description. * + * @see template_preprocess + * @see theme_text_format_wrapper + * * @ingroup themeable */ #} diff --git a/core/themes/stark/templates/form.inc/button.html.twig b/core/themes/stark/templates/form.inc/button.html.twig index 1c16ec9..746d6e6 100644 --- a/core/themes/stark/templates/form.inc/button.html.twig +++ b/core/themes/stark/templates/form.inc/button.html.twig @@ -1,13 +1,17 @@ {# /** - * Returns HTML for a button form element. + * @file + * Default theme implementation for a button form element. * * Available variables * - element: The element. * - attributes: Remaining HTML attributes for the element. * + * @TODO remove this file once http://drupal.org/node/1812724 is resolved. + * + * @see template_preprocess + * * @ingroup themeable */ - @TODO remove this file once http://drupal.org/node/1812724 is resolved. #} -{% include "core/themes/stark/templates/form.inc/input.html.twig" %} \ No newline at end of file +{% include "core/themes/stark/templates/form.inc/input.html.twig" %} diff --git a/core/themes/stark/templates/form.inc/checkbox.html.twig b/core/themes/stark/templates/form.inc/checkbox.html.twig index 539c0e7..68da049 100644 --- a/core/themes/stark/templates/form.inc/checkbox.html.twig +++ b/core/themes/stark/templates/form.inc/checkbox.html.twig @@ -1,13 +1,17 @@ {# /** - * Returns HTML for a checkbox form element. + * @file + * Default theme implementation for a checkbox form element. * * Available variables * - element: The element. * - attributes: Remaining HTML attributes for the element. * + * @TODO remove this file once http://drupal.org/node/1812724 is resolved. + * + * @see template_preprocess + * * @ingroup themeable */ - @TODO remove this file once http://drupal.org/node/1812724 is resolved. #} -{% include "core/themes/stark/templates/form.inc/input.html.twig" %} \ No newline at end of file +{% include "core/themes/stark/templates/form.inc/input.html.twig" %} diff --git a/core/themes/stark/templates/form.inc/date.html.twig b/core/themes/stark/templates/form.inc/date.html.twig index c26af36..04b0128 100644 --- a/core/themes/stark/templates/form.inc/date.html.twig +++ b/core/themes/stark/templates/form.inc/date.html.twig @@ -1,10 +1,13 @@ {# /** - * Returns HTML for a date selection form element. + * @file + * Default theme implementation for a date selection form element. * * Available variables - * - element: The properties of the element. - * - attributes: Remaining HTML attributes for the element. + * - element: The properties of the element. + * - attributes: Remaining HTML attributes for the element. + * + * @see template_preprocess * * @ingroup themeable */ diff --git a/core/themes/stark/templates/form.inc/fieldset.html.twig b/core/themes/stark/templates/form.inc/fieldset.html.twig index dee891c..979dc81 100644 --- a/core/themes/stark/templates/form.inc/fieldset.html.twig +++ b/core/themes/stark/templates/form.inc/fieldset.html.twig @@ -1,11 +1,11 @@ {# /** * @file - * Returns HTML for a fieldset form element and its children. + * Default theme implementation for a fieldset form element and its children. * * Available variables: - * - element: An associative array containing the properties of the element. - * - attributes: Remaining HTML attributes for the element. + * - element: An associative array containing the properties of the element. + * - attributes: Remaining HTML attributes for the element. * * @see template_preprocess * @see template_preprocess_fieldset @@ -27,4 +27,4 @@ {{ value }} {% endif %}
- \ No newline at end of file + diff --git a/core/themes/stark/templates/form.inc/form-element.html.twig b/core/themes/stark/templates/form.inc/form-element.html.twig index 80deff0..3c7e5b4 100644 --- a/core/themes/stark/templates/form.inc/form-element.html.twig +++ b/core/themes/stark/templates/form.inc/form-element.html.twig @@ -1,18 +1,20 @@ {# /** - * Returns HTML for a form element. + * @file + * Default theme implementation for a form element. * - * Available variables - * - element: An associative array containing the properties of the element. - * Properties used: #title, #title_display, #description, #id, #required, - * #children, #type, #name. - * - attributes: Remaining HTML attributes for the element. - * - label_display: - * - label: contains label.title and label.attributes - * - required: required.display is TRUE or FALSE indicating the required state of the form element - * - prefix: prefix for the form element - * - suffix: suffix for the form element - * - description: + * Available variables: + * - element: An associative array containing the properties of the element. + * Properties used: #title, #title_display, #description, #id, #required, + * #children, #type, #name. + * - attributes: Remaining HTML attributes for the element. + * - label_display: + * - label: contains label.title and label.attributes + * - required: required.display is TRUE or FALSE indicating the required state + * of the form element + * - prefix: prefix for the form element + * - suffix: suffix for the form element + * - description: * * @see template_preprocess * @see template_preprocess_form_element diff --git a/core/themes/stark/templates/form.inc/form-required-marker.html.twig b/core/themes/stark/templates/form.inc/form-required-marker.html.twig index 72f7a64..6dcec05 100644 --- a/core/themes/stark/templates/form.inc/form-required-marker.html.twig +++ b/core/themes/stark/templates/form.inc/form-required-marker.html.twig @@ -1,9 +1,12 @@ {# /** - * Returns HTML for a marker for required form elements. + * @file + * Default theme implementation for a marker for required form elements. * * Available variables: - * - attributes: Remaining HTML attributes for the element. + * - attributes: Remaining HTML attributes for the element. + * + * @see template_preprocess * * @ingroup themeable */ diff --git a/core/themes/stark/templates/form.inc/image-button.html.twig b/core/themes/stark/templates/form.inc/image-button.html.twig index f2daae1..c99c7f9 100644 --- a/core/themes/stark/templates/form.inc/image-button.html.twig +++ b/core/themes/stark/templates/form.inc/image-button.html.twig @@ -1,13 +1,17 @@ {# /** - * Returns HTML for an image button form element. + * @file + * Default theme implementation for an image button form element. * * Available variables - * - element: The element. - * - attributes: Remaining HTML attributes for the element. + * - element: The element. + * - attributes: Remaining HTML attributes for the element. + * + * @TODO remove this file once http://drupal.org/node/1812724 is resolved. + * + * @see template_preprocess * * @ingroup themeable */ - @TODO remove this file once http://drupal.org/node/1812724 is resolved. #} -{% include "core/themes/stark/templates/form.inc/input.html.twig" %} \ No newline at end of file +{% include "core/themes/stark/templates/form.inc/input.html.twig" %} diff --git a/core/themes/stark/templates/form.inc/input.html.twig b/core/themes/stark/templates/form.inc/input.html.twig index cd9f997..09e1279 100644 --- a/core/themes/stark/templates/form.inc/input.html.twig +++ b/core/themes/stark/templates/form.inc/input.html.twig @@ -1,6 +1,8 @@ {# -/* - * Returns the html for an input field +/** + * @file + * Default theme implementation for an input field. + * * This covers input types: * - radio * - checkbox @@ -16,6 +18,9 @@ * - attributes: HTML attributes. * - attributes.class: The classes to apply to the element. * + * @see template_preprocess + * + * @ingroup themable */ #} - \ No newline at end of file + diff --git a/core/themes/stark/templates/form.inc/number.html.twig b/core/themes/stark/templates/form.inc/number.html.twig index 0922b5d..df6379d 100644 --- a/core/themes/stark/templates/form.inc/number.html.twig +++ b/core/themes/stark/templates/form.inc/number.html.twig @@ -1,13 +1,17 @@ {# /** - * Returns HTML for a number form element. + * @file + * Default theme implementation for a number form element. * * Available variables * - element: The element. * - attributes: Remaining HTML attributes for the element. * + * @TODO remove this file once http://drupal.org/node/1812724 is resolved. + * + * @see template_preprocess() + * * @ingroup themeable */ - @TODO remove this file once http://drupal.org/node/1812724 is resolved. #} -{% include "core/themes/stark/templates/form.inc/input.html.twig" %} \ No newline at end of file +{% include "core/themes/stark/templates/form.inc/input.html.twig" %} diff --git a/core/themes/stark/templates/form.inc/radio.html.twig b/core/themes/stark/templates/form.inc/radio.html.twig index f61efe5..69c4f6d 100644 --- a/core/themes/stark/templates/form.inc/radio.html.twig +++ b/core/themes/stark/templates/form.inc/radio.html.twig @@ -1,13 +1,17 @@ {# /** - * Returns HTML for a radio button form element. + * @file + * Default theme implementation for a radio button form element. * * Available variables * - element: The element. * - attributes: Remaining HTML attributes for the element. * + * @TODO remove this file once http://drupal.org/node/1812724 is resolved. + * + * @see template_preprocess() + * * @ingroup themeable */ - @TODO remove this file once http://drupal.org/node/1812724 is resolved. #} -{% include "core/themes/stark/templates/form.inc/input.html.twig" %} \ No newline at end of file +{% include "core/themes/stark/templates/form.inc/input.html.twig" %} diff --git a/core/themes/stark/templates/form.inc/textarea.html.twig b/core/themes/stark/templates/form.inc/textarea.html.twig index e3de6f0..f022a1f 100644 --- a/core/themes/stark/templates/form.inc/textarea.html.twig +++ b/core/themes/stark/templates/form.inc/textarea.html.twig @@ -1,13 +1,14 @@ {# /** - * Returns HTML for a textarea form element. + * @file + * Default theme implementation for a textarea form element. * * @see template_preprocess * @see template_preprocess_textarea * + * @ingroup themable */ #} - diff --git a/core/themes/stark/templates/forum/forum-icon.html.twig b/core/themes/stark/templates/forum/forum-icon.html.twig index 8652ba8..538d244 100644 --- a/core/themes/stark/templates/forum/forum-icon.html.twig +++ b/core/themes/stark/templates/forum/forum-icon.html.twig @@ -1,7 +1,7 @@ {# /** * @file - * Displays an appropriate icon for a forum post. + * 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. @@ -10,8 +10,8 @@ * - icon_title: @TODO * - first_new: Indicates whether this is the first topic with new posts. * - * @see template_preprocess_forum_icon() - * @see theme_forum_icon() + * @see template_preprocess + * @see template_preprocess_forum_icon * * @ingroup themeable */ diff --git a/core/themes/stark/templates/forum/forum-list.html.twig b/core/themes/stark/templates/forum/forum-list.html.twig index 8c18104..f8c6f83 100644 --- a/core/themes/stark/templates/forum/forum-list.html.twig +++ b/core/themes/stark/templates/forum/forum-list.html.twig @@ -1,7 +1,7 @@ {# /** * @file - * Displays a list of forums and containers. + * Default theme implementation to display a list of forums and containers. * * Available variables: * - forums: An array of forums and containers to display. It is keyed to the @@ -26,12 +26,13 @@ * - forum_id: Forum ID for the current forum. Parent to all items within the * forums array. * - * @see template_preprocess_forum_list() - * @see theme_forum_list() + * @TODO Replace this with existing theme functions: http://drupal.org/node/1812684 + * + * @see template_preprocess + * @see template_preprocess_forum_list * * @ingroup themeable */ - @TODO create this output using existing theme functions: http://drupal.org/node/1812684 #} diff --git a/core/themes/stark/templates/forum/forum-submitted.html.twig b/core/themes/stark/templates/forum/forum-submitted.html.twig index 119df2a..8121a83 100644 --- a/core/themes/stark/templates/forum/forum-submitted.html.twig +++ b/core/themes/stark/templates/forum/forum-submitted.html.twig @@ -1,7 +1,7 @@ {# /** * @file - * Formats a forum post submission string. + * Default theme implementation formats a forum post submission string. * * The submission string indicates when and by whom a topic was submitted. * @@ -11,8 +11,8 @@ * - topic: An object with the raw data of the post. Potentially unsafe. Be * sure to clean this data before printing. * - * @see template_preprocess_forum_submitted() - * @see theme_forum_submitted() + * @see template_preprocess + * @see template_preprocess_forum_submitted * * @ingroup themeable */ diff --git a/core/themes/stark/templates/forum/forum-topic-list.html.twig b/core/themes/stark/templates/forum/forum-topic-list.html.twig index a5c6737..13513fb 100644 --- a/core/themes/stark/templates/forum/forum-topic-list.html.twig +++ b/core/themes/stark/templates/forum/forum-topic-list.html.twig @@ -1,7 +1,7 @@ {# /** * @file - * Displays a list of forum topics. + * Default theme implementation to display a list of forum topics. * * Available variables: * - header: The table header. This is pre-generated with click-sorting @@ -30,8 +30,8 @@ * - topic.timestamp: The raw timestamp this topic was posted. * - topic_id: Numeric ID for the current forum topic. * - * @see template_preprocess_forum_topic_list() - * @see theme_forum_topic_list() + * @see template_preprocess + * @see template_preprocess_forum_topic_list * * @ingroup themeable */ diff --git a/core/themes/stark/templates/forum/forums.html.twig b/core/themes/stark/templates/forum/forums.html.twig index 1cc8961..834fc15 100644 --- a/core/themes/stark/templates/forum/forums.html.twig +++ b/core/themes/stark/templates/forum/forums.html.twig @@ -1,7 +1,7 @@ {# /** * @file - * Displays a forum. + * Default theme implementation to display a forum. * * May contain forum containers as well as forum topics. * @@ -10,7 +10,8 @@ * - topics: The topics to display (as processed by forum-topic-list.html.twig). * - forums_defined: A flag to indicate that the forums are configured. * - * @see template_preprocess_forums() + * @see template_preprocess + * @see template_preprocess_forums * * @ingroup themeable */ diff --git a/core/themes/stark/templates/image/image-formatter.html.twig b/core/themes/stark/templates/image/image-formatter.html.twig index c8d407a..711398e 100644 --- a/core/themes/stark/templates/image/image-formatter.html.twig +++ b/core/themes/stark/templates/image/image-formatter.html.twig @@ -1,21 +1,21 @@ {# /** - * * @file - * Returns HTML for an image field formatter. + * Default theme implementation to display a formatted image field. + * + * Available variables: + * - item: A collection of image data. + * - style: An optional image style. + * - path: An optional array containing the link 'path' and link 'options'. * - * Available variables: - * - item: A collection of image data. - * - style: An optional image style. - * - path: An optional array containing the link 'path' and link 'options'. + * @TODO: Make twig able to find templates as per http://drupal.org/node/1777532 + * @TODO: Make this file accommodate links via path, above. * - * @see template_preprocess() - * @see template_preprocess_image_formatter() + * @see template_preprocess + * @see template_preprocess_image_formatter * - * @ingroup themeable + * @ingroup themeable */ - @TODO: Make twig able to find templates as per http://drupal.org/node/1777532 - @TODO: Make this file accommodate links via path, above. #}
{% if style %} @@ -28,4 +28,4 @@ {{ item.caption }} {% endif %} -
\ No newline at end of file + diff --git a/core/themes/stark/templates/image/image-style-preview.html.twig b/core/themes/stark/templates/image/image-style-preview.html.twig index 3db4987..c6216f0 100644 --- a/core/themes/stark/templates/image/image-style-preview.html.twig +++ b/core/themes/stark/templates/image/image-style-preview.html.twig @@ -1,17 +1,37 @@ {# - @file - Returns HTML for a preview of an image style. - - @param $variables - An associative array containing: - - style: The image style array being previewed. - - @see template_preprocess - @see template_preprocess_image_style_preview - - @ingroup themeable +/** + * @file + * Default theme implementation to display a preview of an image style. + * + * Available variables: + * - original_image: @TODO + * - original_image.height: The height in pixels of the original image. + * - original_image.width: The width in pixels of the original image. + * - original_height: The same as original_image.height + * - original_width: The same as original_image.width + * - original_url: The URL of the original image. + * - original_style_view: Text information about the original style. + * - original_attributes: An array of attributes for the original style. + * - original_attributes.style: Inline CSS style for the original image. + * + * - preview_image: @TODO + * - preview_image.height: The height in pixels of the preview image. + * - preview_image.width: The width in pixels of the preview image. + * - preview_height: The same as preview_image.height + * - preview_width: The same as preview_image.height + * - preview_image_url: The URL of the preview image. + * - preview_attributes: An array of attributes for the preview style. + * - preview_attributes.style: Inline CSS style for the preview image. + * + * - image_style_name: @TODO + * - actual_style_view: @TODO + * + * @see template_preprocess + * @see template_preprocess_image_style_preview + * + * @ingroup themeable + */ #} - {# Build the preview of the original image. #}
{{ 'original'|t }} ({{ original_style_view }}) diff --git a/core/themes/stark/templates/image/image-style.html.twig b/core/themes/stark/templates/image/image-style.html.twig index 658c2f4..5c22b02 100644 --- a/core/themes/stark/templates/image/image-style.html.twig +++ b/core/themes/stark/templates/image/image-style.html.twig @@ -1,29 +1,29 @@ {# /** - * * @file - * Returns HTML for an image using a specific image style. + * Displays html for an image using a specific image style. + * + * Available variables: + * - style: The name of the style to be used to alter the original image. + * - width: The width of the source image (if known). + * - height: The height of the source image (if known). + * - alt: The alternative text for text-based browsers. + * - title: The title text is displayed when the image is hovered in some + * popular browsers. + * - src: The path of the image file relative to the Drupal files directory. + * This function does not work with images outside the files directory + * nor with remotely hosted images. This should be in a format such as + * 'images/image.jpg', or using a stream wrapper such as + * 'public://images/image.jpg'. + * - attributes: Attributes to be placed in the img tag. * - * Available variables: - * - style: The name of the style to be used to alter the original image. - * - width: The width of the source image (if known). - * - height: The height of the source image (if known). - * - alt: The alternative text for text-based browsers. - * - title: The title text is displayed when the image is hovered in some - * popular browsers. - * - src: The path of the image file relative to the Drupal files directory. - * This function does not work with images outside the files directory - * nor with remotely hosted images. This should be in a format such as - * 'images/image.jpg', or using a stream wrapper such as - * 'public://images/image.jpg'. - * - attributes: Attributes to be placed in the img tag. + * @see template_preprocess + * @see template_preprocess_image_style * - * @see template_preprocess() - * @see template_preprocess_image_style() + * @TODO: remove include path once http://drupal.org/node/1777532 is resolved. * - * @ingroup themeable + * @ingroup themeable */ - @TODO: remove include path once http://drupal.org/node/1777532 is resolved #} {# Pass straight through to image template #} {% include 'core/themes/stark/templates/theme.inc/image.html.twig' %} diff --git a/core/themes/stark/templates/menu/menu-tree.html.twig b/core/themes/stark/templates/menu/menu-tree.html.twig index 7a277b1..995e539 100644 --- a/core/themes/stark/templates/menu/menu-tree.html.twig +++ b/core/themes/stark/templates/menu/menu-tree.html.twig @@ -1,12 +1,15 @@ {# /** - * Returns HTML for a wrapper for a menu sub-tree. + * @file + * Displays html for a wrapper for a menu sub-tree. * * Available variables: - * - tree: An HTML string containing the tree's items. + * - tree: An html string containing the tree's items. + * + * @see template_preprocess + * @see template_preprocess_menu_tree * - * @see template_preprocess_menu_tree() * @ingroup themeable */ #} - \ No newline at end of file + diff --git a/core/themes/stark/templates/menu/menu.html.twig b/core/themes/stark/templates/menu/menu.html.twig index 9bbadf6..79fc867 100644 --- a/core/themes/stark/templates/menu/menu.html.twig +++ b/core/themes/stark/templates/menu/menu.html.twig @@ -1,3 +1,24 @@ +{# +/** + * @file + * Displays html for a menu sub-tree. + * + * Available variables: + * - menu_level: integer value indicating the depth of the menu sub-tree. A + * value of 1 means the top-level, 2 would be the second level, and so on. + * - items: an associative array of items in the menu sub-tree. + * - item: + * - link: + * - content: + * - active_trail: + * - children: + * + * @see template_preprocess + * @see template_preprocess_menu + * + * @ingroup themeable + */ +#} {% if menu_level = 1 %}
\ No newline at end of file + diff --git a/core/themes/stark/templates/node/node-recent-content.html.twig b/core/themes/stark/templates/node/node-recent-content.html.twig index 3a02cd4..e70ed5a 100644 --- a/core/themes/stark/templates/node/node-recent-content.html.twig +++ b/core/themes/stark/templates/node/node-recent-content.html.twig @@ -1,20 +1,18 @@ {# /** * @file - * Returns HTML for a recent node to be displayed in the recent content block. + * Default theme implementation for a recent node to be displayed in the recent content block. * * Available variables: * - path: Path to content - * - mark: HTML marker for new or updated content + * - mark: html marker for new or updated content * - username: The author of the content * * @see template_preprocess - * * @see template_preprocess_node_recent_content * * @ingroup themable - * */ #} - -
{{ path }}{{ mark }}
{{ username }}
+
{{ path }}{{ mark }}
+
{{ username }}
diff --git a/core/themes/stark/templates/node/node.html.twig b/core/themes/stark/templates/node/node.html.twig index 362737a..3ff97c6 100644 --- a/core/themes/stark/templates/node/node.html.twig +++ b/core/themes/stark/templates/node/node.html.twig @@ -68,17 +68,16 @@ * desired field language; for example, $node->body['en'], thus overriding any * language negotiation rule that was previously applied. * - * @see template_preprocess() - * @see template_preprocess_node() + * @see template_preprocess + * @see template_preprocess_node + * + * @TODO: might be a good idea to remove the id attribute, because if that gets + * rendered twice on a page this is invalid CSS for example: two lists + * in different view modes. * * @ingroup themeable */ #} -{# - @todo: might be a good idea to remove the id attribute, because if that gets - rendered twice on a page this is invalid CSS - for example: two lists in different view modes. -#}
{{ title_prefix }} diff --git a/core/themes/stark/templates/overlay/overlay.html.twig b/core/themes/stark/templates/overlay/overlay.html.twig index 3d231bf..5a997fc 100644 --- a/core/themes/stark/templates/overlay/overlay.html.twig +++ b/core/themes/stark/templates/overlay/overlay.html.twig @@ -9,8 +9,8 @@ * - tabs: Tabs linking to any sub-pages beneath the current page (e.g., the view * and edit tabs when displaying a node). * - * @see template_preprocess() - * @see template_preprocess_overlay() + * @see template_preprocess + * @see template_preprocess_overlay * * @ingroup themeable */ diff --git a/core/themes/stark/templates/poll/poll-results.html.twig b/core/themes/stark/templates/poll/poll-results.html.twig index 947116d..ba55b6f 100644 --- a/core/themes/stark/templates/poll/poll-results.html.twig +++ b/core/themes/stark/templates/poll/poll-results.html.twig @@ -1,16 +1,21 @@ {# - @file - Default theme implementation to display the poll results in a block. - - Available variables: - - block: True if poll is in a block. - - title: The title of the block. - - results: Lists the poll results. - - total_votes: The total results in the poll - - cancel_form: Cancel button. - - links: Links in the poll. - - @ingroup themeable +/** + * @file + * Default theme implementation to display the poll results in a block. + * + * Available variables: + * - block: True if poll is in a block. + * - title: The title of the block. + * - results: Lists the poll results. + * - total_votes: The total results in the poll + * - cancel_form: Cancel button. + * - links: Links in the poll. + * + * @see template_preprocess + * @see template_preprocess_poll_results + * + * @ingroup themeable + */ #}
{% if block %} @@ -24,4 +29,4 @@ {% if block %}
{{ links }}
{% endif %} -
\ No newline at end of file + diff --git a/core/themes/stark/templates/poll/poll-vote.html.twig b/core/themes/stark/templates/poll/poll-vote.html.twig index b61c56e..fa4946b 100644 --- a/core/themes/stark/templates/poll/poll-vote.html.twig +++ b/core/themes/stark/templates/poll/poll-vote.html.twig @@ -1,15 +1,21 @@ {# - @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. - - block: True if this is being displayed as a block. - - vote: The vote button - - rest: Anything else in the form that may have been added via - form_alter hooks. - - @see template_preprocess_poll_vote() +/** + * @file + * Default theme implementation to display voting form for a poll. + * + * Available variables: + * - choice: The radio buttons for the choices in the poll. + * - title: The title of the poll. + * - block: True if this is being displayed as a block. + * - vote: The vote button. + * - rest: Anything else in the form that may have been added via + * form_alter hooks. + * + * @see template_preprocess + * @see template_preprocess_poll_vote + * + * @ingroup themable + */ #}
diff --git a/core/themes/stark/templates/rdf/rdf-metadata.html.twig b/core/themes/stark/templates/rdf/rdf-metadata.html.twig index 38e6f90..73c3729 100644 --- a/core/themes/stark/templates/rdf/rdf-metadata.html.twig +++ b/core/themes/stark/templates/rdf/rdf-metadata.html.twig @@ -13,8 +13,8 @@ * - metadata: Each item in the array corresponds to its own set of attributes, * and therefore, needs its own element. * - * @see template_preprocess() - * @see template_preprocess_rdf_metadata() + * @see template_preprocess + * @see template_preprocess_rdf_metadata * * @ingroup themeable * @ingroup rdf diff --git a/core/themes/stark/templates/search/search-result.html.twig b/core/themes/stark/templates/search/search-result.html.twig index a88e469..7795b18 100644 --- a/core/themes/stark/templates/search/search-result.html.twig +++ b/core/themes/stark/templates/search/search-result.html.twig @@ -32,9 +32,9 @@ * being the count. Depends on comment.module. * * Other variables: - * - title_attributes: Array of HTML attributes for the title. It is + * - title_attributes: Array of html attributes for the title. It is * flattened into a string within the variable title_attributes. - * - content_attributes: Array of HTML attributes for the content. It is + * - content_attributes: Array of html attributes for the content. It is * flattened into a string within the variable content_attributes. * * Since info_split is keyed, a direct print of the item is possible. @@ -49,15 +49,17 @@ * {% endif %} * @endcode * - * TODO: debug output needs to convert in twig format + * @TODO: debug output needs to convert in twig format * To check for all available data within $info_split, use the code below. * @code * '. check_plain(print_r($info_split, 1)) .''; ?> * @endcode * - * @see template_preprocess() - * @see template_preprocess_search_result() - * @see template_process() + * @see template_preprocess + * @see template_preprocess_search_result + * @see template_process + * + * @ingroup themable */ #}
  • diff --git a/core/themes/stark/templates/search/search-results.html.twig b/core/themes/stark/templates/search/search-results.html.twig index 515bc98..37c40df 100644 --- a/core/themes/stark/templates/search/search-results.html.twig +++ b/core/themes/stark/templates/search/search-results.html.twig @@ -1,21 +1,24 @@ {# - - @file - Default theme implementation for displaying search results. - - This template collects each invocation of theme_search_result(). This and - the child template are dependent to one another sharing the markup for - definition lists. - - Note that modules may implement their own search type and theme function - completely bypassing this template. - - Available variables: - search_results: All results as it is rendered through - search-result.tpl.php - module: The machine-readable name of the module (tab) being searched, such as 'node' or 'user' - - @see template_preprocess_search_results() +/** + * @file + * Default theme implementation for displaying search results. + * + * This template collects each invocation of theme_search_result(). This and + * the child template are dependent to one another sharing the markup for + * definition lists. + * + * Note that modules may implement their own search type and theme function + * completely bypassing this template. + * + * Available variables: + * - search_results: All results as it is rendered through search-result.tpl.php + * - module: The machine-readable name of the module (tab) being searched, such + * as 'node' or 'user' + * + * @see template_preprocess + * @see template_preprocess_search_results + * + * @ingroup themable #} {% if search_results %}

    {{ 'Search results'|t }}

    diff --git a/core/themes/stark/templates/system/admin-block.html.twig b/core/themes/stark/templates/system/admin-block.html.twig index fef65a8..0d6ae6e 100644 --- a/core/themes/stark/templates/system/admin-block.html.twig +++ b/core/themes/stark/templates/system/admin-block.html.twig @@ -1,6 +1,7 @@ {# -/* - * Returns HTML for an administrative block for display. +/** + * @file + * Default theme implementation for an administrative block for display. * * Available variables: * - block: contains information about the block @@ -10,6 +11,9 @@ * - description: Description of the block. Only output if 'content' is not * set. * + * @see template_preprocess + * + * @ingroup themable */ #}
    @@ -19,6 +23,7 @@ {% if content is defined %}
    {{ content }}
    {% else %} + {# Only output the description if 'content' is not set. #}
    {{ description }}
    {% endif %} -
    \ No newline at end of file +
    • diff --git a/core/themes/stark/templates/system/admin-page.html.twig b/core/themes/stark/templates/system/admin-page.html.twig index 47adc98..9cdd395 100644 --- a/core/themes/stark/templates/system/admin-page.html.twig +++ b/core/themes/stark/templates/system/admin-page.html.twig @@ -1,12 +1,14 @@ -{# +{# /** * @file - * Returns HTML for an administrative page. + * Default theme implementation for an administrative page. * * Available variables: * - system_compact_link: Themed link to toggle compact view. * - containers: Containers with admin blocks. * + * @see template_preprocess + * * @ingroup themeable */ #} @@ -19,4 +21,4 @@ {% endfor %}
    {% endfor %} - \ No newline at end of file + diff --git a/core/themes/stark/templates/system/block-admin-display-form.html.twig b/core/themes/stark/templates/system/block-admin-display-form.html.twig index aab2546..c65875c 100644 --- a/core/themes/stark/templates/system/block-admin-display-form.html.twig +++ b/core/themes/stark/templates/system/block-admin-display-form.html.twig @@ -1,26 +1,29 @@ {# - @file - Default theme implementation to configure blocks. - * - Available variables: - - $block_regions: An array of regions. Keyed by name with the title as value. - - $block_listing: An array of blocks keyed by region and then delta. - - $form_submit: Form submit button. - * - Each $block_listing[$region] contains an array of blocks for that region. - * - Each $data in $block_listing[$region] contains: - - $data->region_title: Region title for the listed block. - - $data->block_title: Block title. - - $data->region_select: Drop-down menu for assigning a region. - - $data->weight_select: Drop-down menu for setting weights. - - $data->configure_link: Block configuration link. - - $data->delete_link: For deleting user added blocks. - * - @see template_preprocess_block_admin_display_form() - @see theme_block_admin_display() - * - @ingroup themeable +/** + * @file + * Default theme implementation to configure blocks. + * + * Available variables: + * - block_regions: An array of regions. Keyed by name with the title as value. + * - block_listing: An array of blocks keyed by region and then delta. + * - form_submit: A renderable form submit button. + * + * Each block_listing[region] contains an array of blocks for that region. + * + * Each data in block_listing[region] contains: + * - data.region_title: Region title for the listed block. + * - data.block_title: Block title. + * - data.region_select: Drop-down menu for assigning a region. + * - data.weight_select: Drop-down menu for setting weights. + * - data.configure_link: Block configuration link. + * - data.delete_link: For deleting user added blocks. + * + * @see template_preprocess + * @see template_preprocess_block_admin_display_form + * @see theme_block_admin_display + * + * @ingroup themeable + */ #}
    @@ -51,4 +54,4 @@ {% endfor %}
    -{{ render(form_submit) }} \ No newline at end of file +{{ render(form_submit) }} diff --git a/core/themes/stark/templates/system/exposed-filters.html.twig b/core/themes/stark/templates/system/exposed-filters.html.twig index 2dd6649..45e963b 100644 --- a/core/themes/stark/templates/system/exposed-filters.html.twig +++ b/core/themes/stark/templates/system/exposed-filters.html.twig @@ -1,7 +1,7 @@ {# /** * @file - * Returns HTML for an exposed filter form. + * Default theme implementation for an exposed filter form. * * Available variables: * - form: An associative array containing the structure of the form. diff --git a/core/themes/stark/templates/system/html.html.twig b/core/themes/stark/templates/system/html.html.twig index 071fa2a..3894f7b 100644 --- a/core/themes/stark/templates/system/html.html.twig +++ b/core/themes/stark/templates/system/html.html.twig @@ -1,8 +1,7 @@ {# /** * @file - * Default theme implementation to display the basic html structure of a single - * Drupal page. + * Default theme implementation for the basic structure of a single Drupal page. * * Variables: * - $css: An array of CSS files for the current page. @@ -34,9 +33,11 @@ * - $classes String of classes that can be used to style contextually through * CSS. * - * @see template_preprocess() - * @see template_preprocess_html() - * @see template_process() + * @see template_preprocess + * @see template_preprocess_html + * @see template_process + * + * @ingroup themable */ #} diff --git a/core/themes/stark/templates/system/maintenance-page.html.twig b/core/themes/stark/templates/system/maintenance-page.html.twig index a238c07..f787a85 100644 --- a/core/themes/stark/templates/system/maintenance-page.html.twig +++ b/core/themes/stark/templates/system/maintenance-page.html.twig @@ -6,8 +6,10 @@ * All the available variables are mirrored in html.tpl.php and page.tpl.php. * Some may be blank but they are provided for consistency. * - * @see template_preprocess() - * @see template_preprocess_maintenance_page() + * @see template_preprocess + * @see template_preprocess_maintenance_page + * + * @ingroup themable */ #} diff --git a/core/themes/stark/templates/system/page.html.twig b/core/themes/stark/templates/system/page.html.twig index ebcfb76..2c2b4ce 100644 --- a/core/themes/stark/templates/system/page.html.twig +++ b/core/themes/stark/templates/system/page.html.twig @@ -63,9 +63,11 @@ * - page.header: Items for the header region. * - page.footer: Items for the footer region. * - * @see template_preprocess() - * @see template_preprocess_page() + * @see template_preprocess + * @see template_preprocess_page * @see html.html.twig + * + * @ingroup themable */ #}
    @@ -106,14 +108,14 @@
    diff --git a/core/themes/stark/templates/theme.inc/progress-bar.html.twig b/core/themes/stark/templates/theme.inc/progress-bar.html.twig index 66184de..cb4e9f8 100644 --- a/core/themes/stark/templates/theme.inc/progress-bar.html.twig +++ b/core/themes/stark/templates/theme.inc/progress-bar.html.twig @@ -1,13 +1,17 @@ {# /** - * Returns HTML for a progress bar. + * @file + * Default theme implementation for a progress bar. * * Note that the core Batch API uses this only for non-JavaScript batch jobs. * - * @param $variables - * An associative array containing: - * - percent: The percentage of the progress. - * - message: A string containing information to be displayed. + * Available variables: + * - percent: The percentage of the progress. + * - message: A string containing information to be displayed. + * + * @see template_preprocess + * + * @ingroup themable */ #}
    '; diff --git a/core/themes/stark/templates/theme.inc/table.html.twig b/core/themes/stark/templates/theme.inc/table.html.twig index 3534b3b..a8d1d66 100644 --- a/core/themes/stark/templates/theme.inc/table.html.twig +++ b/core/themes/stark/templates/theme.inc/table.html.twig @@ -10,21 +10,21 @@ * - header.field: The database field represented in the table column * (required if user is to be able to sort on this column). * - header.sort: A default sort order for this column ("asc" or "desc"). - * - header.attributes: Any HTML attributes, such as "colspan", to apply + * - header.attributes: Any html attributes, such as "colspan", to apply * to the column header cell. * - rows: The table rows. Every row contains cells that can be accessed with * the following keys: * - row.data: the cells. - * - row.attributes: Any HTML attributes, such as "class", to apply to the + * - row.attributes: Any html attributes, such as "class", to apply to the * table row. * - row.no_striping: a flag indicating that the row should receive no * 'even / odd' styling. Defaults to FALSE. * A cell can be either a string or may contain the following keys: * - data: The string to display in the table cell. * - header: Indicates this cell is a header. - * - attributes: Any HTML attributes, such as "colspan", to apply to the + * - attributes: Any html attributes, such as "colspan", to apply to the * table cell. - * - attributes: An array of HTML attributes to apply to the table tag. + * - attributes: An array of html attributes to apply to the table tag. * - caption: A localized string to use for the tag. * - colgroups: An array of column groups. * - sticky: Use a "sticky" table header. diff --git a/core/themes/stark/templates/theme.inc/tablesort-indicator.html.twig b/core/themes/stark/templates/theme.inc/tablesort-indicator.html.twig index bcfd897..6eceda8 100644 --- a/core/themes/stark/templates/theme.inc/tablesort-indicator.html.twig +++ b/core/themes/stark/templates/theme.inc/tablesort-indicator.html.twig @@ -1,15 +1,15 @@ {# /** * @file - * Overrides theme_tablesort_indicator(). + * Default theme implementation for displaying a tablesort indicator. * * Available variables: * - style: Set to either 'asc' or 'desc'. Indicate which icon to use. * - src: URL to ascending or descending image * - attributes: width, height, alt, title * - * @see template_preprocess() - * @see template_preprocess_tablesort_indicator() + * @see template_preprocess + * @see template_preprocess_tablesort_indicator * * @ingroup themeable */ diff --git a/core/themes/stark/templates/theme.inc/vertical-tabs.html.twig b/core/themes/stark/templates/theme.inc/vertical-tabs.html.twig index 1c56389..a130cb1 100644 --- a/core/themes/stark/templates/theme.inc/vertical-tabs.html.twig +++ b/core/themes/stark/templates/theme.inc/vertical-tabs.html.twig @@ -1,14 +1,16 @@ {# /** - * Returns HTML for an element's children fieldsets as vertical tabs. + * @file + * Default theme implementation for an element's child fieldsets as vertical tabs. * - * @param $variables - * An associative array containing: - * - element: An associative array containing the properties and children of - * the fieldset. Properties used: #children. + * Available variables: + * - element: An associative array containing the properties and children of + * the fieldset. Properties used: #children. + * + * @see template_preprocess * * @ingroup themeable */ #}

    {{ "Vertical tabs"|t }}

    -
    {{ element }}
    \ No newline at end of file +
    {{ element }}
    diff --git a/core/themes/stark/templates/theme.maintenance.inc/task-list.html.twig b/core/themes/stark/templates/theme.maintenance.inc/task-list.html.twig index 20c84d0..0835f84 100644 --- a/core/themes/stark/templates/theme.maintenance.inc/task-list.html.twig +++ b/core/themes/stark/templates/theme.maintenance.inc/task-list.html.twig @@ -1,14 +1,14 @@ {# /** - * Returns HTML for a list of maintenance tasks to perform. - * * @file - * theme_task_list($variables) + * Default theme implementation for a list of maintenance tasks to perform. * * Available variables: * - attributes: Information related to the maintenance tasks. * - items: An associative array of maintenance tasks. * + * @see template_preprocess + * * @ingroup themeable */ #} diff --git a/core/themes/stark/templates/title.html.twig b/core/themes/stark/templates/title.html.twig index 35bf7a5..bbc13fb 100644 --- a/core/themes/stark/templates/title.html.twig +++ b/core/themes/stark/templates/title.html.twig @@ -5,24 +5,26 @@ * * Available variables: * - title: The title being printed in this template. - * - element: The HTML element used to identify the title. - * - attributes: Remaining HTML attributes for the containing element. - * - attributes.id: A valid HTML ID and guaranteed unique. - * - attributes.class: Classes that can be used to style contextually through + * - element: The html element used to identify the title. + * - attributes: Remaining html attributes for the containing element. + * - attributes.id: A valid html ID and guaranteed unique. + * - attributes.class: Classes that can be used to style contextually through * CSS. These can be manipulated through from preprocess functions. * The default values can be one or more of the following: * @TODO * - title.prefix: Additional output populated by modules, intended to be * displayed in front of the main title tag that appears in the template. - * - title.suffix: Additional output populated by modules, intended to be + * - title.suffix: Additional output populated by modules, intended to be * displayed after the main title tag that appears in the template. * - * @see template_preprocess() - * @see template_preprocess_title() + * @see template_preprocess + * @see template_preprocess_title + * + * @ingroup themeable */ #} {{ title.prefix }} {% if title %}

    {{ title }}

    {% endif %} -{{ title.suffix }} \ No newline at end of file +{{ title.suffix }} diff --git a/core/themes/stark/templates/toolbar/toolbar.html.twig b/core/themes/stark/templates/toolbar/toolbar.html.twig index d0f436d..f5d177a 100644 --- a/core/themes/stark/templates/toolbar/toolbar.html.twig +++ b/core/themes/stark/templates/toolbar/toolbar.html.twig @@ -12,8 +12,10 @@ * - toolbar['toolbar_menu']: Top level management menu links. * - toolbar['toolbar_drawer']: A place for extended toolbar content. * - * @see template_preprocess() - * @see template_preprocess_toolbar() + * @see template_preprocess + * @see template_preprocess_toolbar + * + * @ingroup themeable */ #}