Commit b66f35a0 authored by Oliver Bartsch's avatar Oliver Bartsch Committed by Daniel Goerz
Browse files

[BUGFIX] Fix some typos and improve PHPDoc comments

Fixes several typos and improves readability of PHPDoc
comments through ext:dashboard classes.

Resolves: #90486
Releases: master
Change-Id: I27cd1c0c2dd3c3b18bade0b50af41aa8d8bfd06e
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/63368


Tested-by: Richard Haeser's avatarRichard Haeser <richard@maxserv.com>
Tested-by: Susanne Moog's avatarSusanne Moog <look@susi.dev>
Tested-by: default avatarTYPO3com <noreply@typo3.com>
Tested-by: Daniel Goerz's avatarDaniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Richard Haeser's avatarRichard Haeser <richard@maxserv.com>
Reviewed-by: Susanne Moog's avatarSusanne Moog <look@susi.dev>
Reviewed-by: Daniel Goerz's avatarDaniel Goerz <daniel.goerz@posteo.de>
parent ccb1c2c8
......@@ -431,7 +431,7 @@ class DashboardController extends AbstractController
}
/**
* Add the RequireJS modules some widgets need
* Add the RequireJS modules needed by some widgets
*
* @param RequireJsModuleInterface $widgetInstance
*/
......
......@@ -99,7 +99,7 @@ class Dashboard
/**
* This will return a list of all widgets of the current dashboard object. It will only include available
* widgets and will add the initialised object of the widget itself
* widgets and will add the initialized object of the widget itself
*/
public function initializeWidgets(): void
{
......
......@@ -51,7 +51,7 @@ final class DashboardWidgetPass implements CompilerPassInterface
foreach ($container->findTaggedServiceIds($this->tagName) as $serviceName => $tags) {
$definition = $container->findDefinition($serviceName);
$definition->setPublic(true);
// Widgets are handles like prototypes right now (will require state)
// Widgets are handled like prototypes right now (will require state)
// @todo: Widgets should preferably be services, but that will require WidgetInterface
// to change
$definition->setShared(false);
......
......@@ -19,7 +19,7 @@ namespace TYPO3\CMS\Dashboard\Exception;
use TYPO3\CMS\Core\Exception;
/**
* Exception thrown if no dashboard is available for the current user
* Exception is thrown if no dashboard is available for the current user
*/
class NoDashboardAvailableException extends Exception
{
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Dashboard\Widgets;
/**
* The AbstractCtaButtonWidget class is the basic widget class for simple CTA widgets.
* Is it possible to extends this class for own widgets.
* It is possible to extend this class for custom widgets.
* Simply overwrite $this->link and $this->label to make use of this widget type.
*/
abstract class AbstractCtaButtonWidget extends AbstractWidget
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Dashboard\Widgets;
/**
* The AbstractListWidget class is the basic widget class for structured content.
* Is it possible to extends this class for own widgets.
* It is possible to extend this class for custom widgets.
* In your class you have to set $this->items with the data to display.
*/
abstract class AbstractListWidget extends AbstractWidget
......
......@@ -23,7 +23,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* The AbstractRssWidget class is the basic widget class to display items from a RSS feed.
* Is it possible to extends this class for own widgets.
* It is possible to extend this class for custom widgets.
* In your class you have to set $this->rssFile with the URL to the feed.
*/
abstract class AbstractRssWidget extends AbstractListWidget
......
......@@ -22,8 +22,8 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
use TYPO3Fluid\Fluid\View\ViewInterface;
/**
* The AbstractWidget class is the basic widget class for all widgets
* It is possible to extends this class for own widgets, but EXT:dashboard provides
* The AbstractWidget class is the basic widget class for all widgets.
* It is possible to extend this class for custom widgets, but EXT:dashboard provides
* some more specific types of widgets to extend from. For more details, please check:
* @see AbstractCtaButtonWidget
* @see AbstractListWidget
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Dashboard\Widgets;
/**
* This widget will show a link to the documentation of TYPO3 to make it easier for people
* to find the right documentation
* to find the right documentation.
*/
class DocumentationGettingStartedWidget extends AbstractCtaButtonWidget
{
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Dashboard\Widgets;
/**
* This widget will show a link to the documentation of TYPO3 to make it easier for people
* to find the right documentation
* to find the right documentation.
*/
class DocumentationTSconfigReferenceWidget extends AbstractCtaButtonWidget
{
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Dashboard\Widgets;
/**
* This widget will show a link to the documentation of TYPO3 to make it easier for people
* to find the right documentation
* to find the right documentation.
*/
class DocumentationTypoScriptReference extends AbstractCtaButtonWidget
{
......
......@@ -5,7 +5,7 @@ namespace TYPO3\CMS\Dashboard\Widgets\Interfaces;
/**
* Interface AdditionalJavaScriptInterface
* In case a widget should provide additional JavaScript files, the widget must be implemented.
* In case a widget should provide additional JavaScript files, the widget must implement this interface.
*/
interface AdditionalJavaScriptInterface
{
......
......@@ -42,7 +42,7 @@ interface WidgetInterface
public function getWidth(): int;
/**
* This method return the content of a widget. The returned markup will be delivered
* This method returns the content of a widget. The returned markup will be delivered
* by an AJAX call and will not be escaped.
* Be aware of XSS and ensure that the content is well encoded.
* @return string
......
......@@ -18,6 +18,9 @@ namespace TYPO3\CMS\Dashboard\Widgets;
use TYPO3\CMS\Core\Information\Typo3Information;
use TYPO3\CMS\Core\Information\Typo3Version;
/**
* This widget will show general information regarding TYPO3
*/
class T3GeneralInformation extends AbstractWidget
{
protected $title = 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.t3information.title';
......
......@@ -16,8 +16,8 @@ namespace TYPO3\CMS\Dashboard\Widgets;
*/
/**
* This class will make it possible for users to show the latest news from the TYPO3 news RSS feed right on the
* dashboard.
* This widget will show the latest news from the TYPO3 news RSS feed right
* on the dashboard.
*/
class T3NewsWidget extends AbstractRssWidget
{
......
<?php
return [
// Get the content of a widgets
// Get the content of a widget
'ext-dashboard-get-widget-content' => [
'path' => '/ext/dashboard/widget/content',
'target' => TYPO3\CMS\Dashboard\Controller\WidgetAjaxController::class . '::getContent'
......
Supports Markdown
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