From 2a01c3f74ad5c9bf9274698f44855ff51d6038b0 Mon Sep 17 00:00:00 2001
From: Daniel Siepmann <daniel.siepmann@typo3.org>
Date: Mon, 27 Apr 2020 19:01:44 +0200
Subject: [PATCH] [DOCS] Fix warnings of rendering ext:dashboard
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* Fix broken indentation
* Add missing blank line
* Fix wrong used reference target
* Add missing interface to docs, which already was referenced
Resolves: #91199
Releases: master
Change-Id: If42021e0f7b4a0b879ba5be6bde9112b6c7e658d
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/64322
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Björn Jacob <bjoern.jacob@tritum.de>
Tested-by: Richard Haeser <richard@maxserv.com>
Reviewed-by: Björn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Richard Haeser <richard@maxserv.com>
---
.../Documentation/Configuration/WidgetSettings.rst | 2 +-
.../dashboard/Documentation/Developer/Interfaces.rst | 12 ++++++++++--
.../Documentation/Widgets/NumberWithIconWidget.rst | 1 +
3 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/typo3/sysext/dashboard/Documentation/Configuration/WidgetSettings.rst b/typo3/sysext/dashboard/Documentation/Configuration/WidgetSettings.rst
index 09ea909e2c6c..e0875f71cc85 100644
--- a/typo3/sysext/dashboard/Documentation/Configuration/WidgetSettings.rst
+++ b/typo3/sysext/dashboard/Documentation/Configuration/WidgetSettings.rst
@@ -12,7 +12,7 @@ In order to override, the extension which should override has to be loaded after
Concrete options depend on the widget to configure.
Each widget should provide an documentation covering all possible options and their meaning.
-For delivered widgets by ext:dashboard see :ref:`widget`.
+For delivered widgets by ext:dashboard see :ref:`widgets`.
In case an widget defined by ext:dashboard should be adjusted,
the extension has to define a dependency to ext:dashboard.
diff --git a/typo3/sysext/dashboard/Documentation/Developer/Interfaces.rst b/typo3/sysext/dashboard/Documentation/Developer/Interfaces.rst
index c5934a46205f..d261a3749be7 100644
--- a/typo3/sysext/dashboard/Documentation/Developer/Interfaces.rst
+++ b/typo3/sysext/dashboard/Documentation/Developer/Interfaces.rst
@@ -134,7 +134,7 @@ For up to date information, please check the source code.
:returntype: string
:returns: The title used for the button. E.g. an ``LLL:EXT:`` reference like
- ``LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.t3news.moreItems``.
+ ``LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.t3news.moreItems``.
.. php:method:: getLink()
@@ -145,7 +145,7 @@ For up to date information, please check the source code.
:returntype: string
:returns: The target of the link, e.g. ``_blank``.
- ``LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.t3news.moreItems``.
+ ``LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.t3news.moreItems``.
.. php:class:: NumberWithIconDataProviderInterface
@@ -175,3 +175,11 @@ For up to date information, please check the source code.
Doughnut
https://www.chartjs.org/docs/latest/charts/doughnut.html#data-structure
+
+.. php:class:: ListDataProviderInterface
+
+ .. php:method:: getItems()
+
+ :returntype: array
+ :returns: Provide the array if items.
+ Each entry should be a single string.
diff --git a/typo3/sysext/dashboard/Documentation/Widgets/NumberWithIconWidget.rst b/typo3/sysext/dashboard/Documentation/Widgets/NumberWithIconWidget.rst
index 26cde05f1a29..4f25e54574a4 100644
--- a/typo3/sysext/dashboard/Documentation/Widgets/NumberWithIconWidget.rst
+++ b/typo3/sysext/dashboard/Documentation/Widgets/NumberWithIconWidget.rst
@@ -37,6 +37,7 @@ Example
title: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.title'
description: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.failedLogins.description'
iconIdentifier: 'content-widget-number'
+
Options
-------
--
GitLab