Commit abf53912 authored by NickWilde's avatar NickWilde

Setup doxygen groups, add functions/files to groups as required

parent 168bb061
......@@ -13,7 +13,7 @@
*
* @see template_preprocess_views_slideshow_cycle_main_frame_row_item()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div {{ attributes.addClass(classes) }}>
......
......@@ -11,7 +11,7 @@
*
* @see template_preprocess_views_slideshow_()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div id="views_slideshow_cycle_div_{{ vss_id }}_{{ count }}" {{ attributes.addClass(classes) }}>
......
......@@ -10,7 +10,7 @@
*
* @see template_preprocess_views_slideshow_cycle_main_frame()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div id="views_slideshow_cycle_teaser_section_{{ vss_id }}" {{ attributes.addClass(classes) }}>
......
......@@ -11,7 +11,7 @@
*
* @see _views_slideshow_preprocess_views_view_slideshow()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div class="skin-{{ skin }}">
......
......@@ -10,7 +10,7 @@ use Drupal\Component\Utility\Html;
/**
* Views Slideshow: Theme the main frame wrapper.
*
* @ingroup themeable
* @ingroup vss_theme
*/
function template_preprocess_views_slideshow_cycle_main_frame(&$vars) {
$settings = $vars['settings'];
......@@ -143,7 +143,7 @@ function template_preprocess_views_slideshow_cycle_main_frame(&$vars) {
/**
* Views Slideshow slideshow rows.
*
* @ingroup themeable
* @ingroup vss_theme
*/
function template_preprocess_views_slideshow_cycle_main_frame_row(&$vars) {
$current = $vars['count'] + 1;
......@@ -171,7 +171,7 @@ function template_preprocess_views_slideshow_cycle_main_frame_row(&$vars) {
/**
* Views Slideshow slideshow row items.
*
* @ingroup themeable
* @ingroup vss_theme
*/
function template_preprocess_views_slideshow_cycle_main_frame_row_item(&$vars) {
$vars['attributes']['class'][] = 'views-row views-row-' . $vars['count'];
......@@ -191,6 +191,8 @@ function template_preprocess_views_slideshow_cycle_main_frame_row_item(&$vars) {
/**
* Implements hook_preprocess_views_slideshow_pager_fields().
*
* @ingroup vss_theme
*/
function _views_slideshow_cycle_preprocess_views_slideshow_pager_fields(&$vars) {
$slide_count = count($vars['view']->result);
......@@ -236,6 +238,8 @@ function _views_slideshow_cycle_preprocess_views_slideshow_pager_fields(&$vars)
/**
* Implements hook_preprocess_views_slideshow_slide_counter().
*
* @ingroup vss_theme
*/
function _views_slideshow_cycle_preprocess_views_slideshow_slide_counter(&$vars) {
$options = $vars['view']->style_plugin->options['views_slideshow_cycle'];
......
......@@ -9,7 +9,7 @@
*
* @see template_preprocess_views_slideshow_controls_text_next()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<span id="views_slideshow_controls_text_next_{{ vss_id }}" {{ attributes.addClass(classes) }}>
......
......@@ -10,7 +10,7 @@
*
* @see template_preprocess_views_slideshow_controls_text_pause()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<span id="views_slideshow_controls_text_pause_{{ vss_id }}" {{ attributes.addClass(classes) }}>
......
......@@ -9,7 +9,7 @@
*
* @see template_preprocess_views_slideshow_controls_text_previous()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<span id="views_slideshow_controls_text_previous_{{ vss_id }}" {{ attributes.addClass(classes) }}>
......
......@@ -12,7 +12,7 @@
*
* @see template_preprocess_views_slideshow_controls_text()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div id="views_slideshow_controls_text_{{ vss_id }}" {{ attributes.addClass(classes) }}>
......
......@@ -8,7 +8,7 @@
* - slides: The slides.
* - vss_id: The slideshow's id.
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div id="{{ plugin }}_main_{{ vss_id }}" class="{{ plugin }}_main views_slideshow_main">
......
......@@ -10,7 +10,7 @@
*
* @see template_preprocess_views_slideshow_pager_field_field()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div class="views-field-{{ css_identifier }}">
......
......@@ -12,7 +12,7 @@
*
* @see template_preprocess_views_slideshow_pager_field_item()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div id="views_slideshow_pager_field_item_{{ location }}_{{ vss_id }}_{{ count }}" {{ attributes.addClass(classes) }}>
......
......@@ -10,7 +10,7 @@
*
* @see template_preprocess_views_slideshow_pager_field_item()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div id="{{ widget_id }}" {{ attributes.addClass(classes) }}>
......
......@@ -10,7 +10,7 @@
*
* @see template_preprocess_views_slideshow_slide_counter()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
<div id="views_slideshow_slide_counter_{{ vss_id }}" {{ attributes.addClass(classes) }}>
......
......@@ -11,7 +11,7 @@
*
* @see _views_slideshow_preprocess_views_view_slideshow()
*
* @ingroup themeable
* @ingroup vss_templates
*/
#}
{% if slideshow %}
......
......@@ -3,16 +3,31 @@
/**
* @file
* The theme system, which controls the output of views slideshow.
*/
/**
* @defgroup vss_templates Templates
* @{
* Slideshow and component templates.
*
* @see vss_theme
* @}
*/
/**
* @defgroup vss_theme Theme Functions
* @{
* Theme processing and display generation.
*
* Most of the logic behind the generation of the slideshow is here.
*
* This just adds a wrapper div to the slideshow.
* @see vss_templates
*/
use Drupal\Component\Utility\Html;
/**
* Views Slideshow: slideshow.
*
* @ingroup themeable
*/
function _views_slideshow_preprocess_views_view_slideshow(&$vars) {
$options = $vars['view']->style_plugin->options;
......@@ -180,8 +195,6 @@ function _views_slideshow_preprocess_views_view_slideshow(&$vars) {
/**
* Views Slideshow: pager.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_pager_widget_render(&$vars) {
// Add JavaScript settings for the pager type.
......@@ -259,8 +272,6 @@ function template_preprocess_views_slideshow_pager_fields(&$vars) {
/**
* Views Slideshow: pager item.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_pager_field_item(&$vars) {
$vars['attributes']['class'][] = 'views_slideshow_pager_field_item';
......@@ -275,8 +286,6 @@ function template_preprocess_views_slideshow_pager_field_item(&$vars) {
/**
* Views Slideshow: Controls.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_controls_widget_render(&$vars) {
// Add JavaScript settings for the controls type.
......@@ -301,8 +310,6 @@ function template_preprocess_views_slideshow_controls_widget_render(&$vars) {
/**
* The slideshow controls.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_controls_text(&$vars) {
$vars['#attached']['library'][] = 'views_slideshow/controls_text';
......@@ -333,8 +340,6 @@ function template_preprocess_views_slideshow_controls_text(&$vars) {
/**
* Views Slideshow: "previous" control.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_controls_text_previous(&$vars) {
$vars['attributes']['class'][] = 'views_slideshow_controls_text_previous';
......@@ -342,8 +347,6 @@ function template_preprocess_views_slideshow_controls_text_previous(&$vars) {
/**
* Views Slideshow: "pause" control.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_controls_text_pause(&$vars) {
$vars['attributes']['class'][] = 'views_slideshow_controls_text_pause views-slideshow-controls-text-status-play';
......@@ -352,8 +355,6 @@ function template_preprocess_views_slideshow_controls_text_pause(&$vars) {
/**
* Views Slideshow: "next" control.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_controls_text_next(&$vars) {
$vars['attributes']['class'][] = 'views_slideshow_controls_text_next';
......@@ -361,8 +362,6 @@ function template_preprocess_views_slideshow_controls_text_next(&$vars) {
/**
* Views Slideshow: Slide Counter.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_slide_counter_widget_render(&$vars) {
$slide = [
......@@ -379,10 +378,12 @@ function template_preprocess_views_slideshow_slide_counter_widget_render(&$vars)
/**
* Views Slideshow: slide counter.
*
* @ingroup themeable
*/
function template_preprocess_views_slideshow_slide_counter(&$vars) {
$vars['attributes']['class'][] = 'views_slideshow_slide_counter';
$vars['slide_count'] = count($vars['rows']);
}
/**
* @} End of "defgroup vss_theme".
*/
\ No newline at end of file
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