Commit 4d9a0283 authored by Benni Mack's avatar Benni Mack Committed by Wouter Wolters
Browse files

[TASK] Mark various parts with phpdoc internal - part 2

All specific controllers for specific Backend actions, Backend-module related modules,
all hook implementations (where the core uses hooks by itself), and module-specific
ViewHelpers are now marked as @internal to ensure developers what is
part of the public TYPO3 Core API.

within
- EXT:seo
- EXT:setup
- EXT:rte_ckeditor
- EXT:workspaces
- EXT:viewpage
- EXT:tstemplate
- EXT:taskcenter
- EXT:t3editor
- EXT:sys_action
- EXT:sys_note

All leftover @api methods have been removed.

Resolves: #86509
Releases: master
Change-Id: I6e5ee2302055de9ea4c124ca913e4677d62721fe
Reviewed-on: https://review.typo3.org/58529


Tested-by: default avatarTYPO3com <no-reply@typo3.com>
Reviewed-by: Oliver Hader's avatarOliver Hader <oliver.hader@typo3.org>
Tested-by: Oliver Hader's avatarOliver Hader <oliver.hader@typo3.org>
Reviewed-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
parent ad30de1a
......@@ -26,6 +26,7 @@ use TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController;
/**
* Extended controller for link browser
* @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
*/
class BrowseLinksController extends AbstractLinkBrowserController
{
......
......@@ -24,6 +24,7 @@ use TYPO3\CMS\Core\Utility\PathUtility;
/**
* Render rich text editor in FormEngine
* @internal This is a specific Backend FormEngine implementation and is not considered part of the Public TYPO3 API.
*/
class RichTextElement extends AbstractFormElement
{
......
......@@ -21,6 +21,7 @@ use TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement;
/**
* This resolver will return the RichTextElement render class if RTE is enabled for this field.
* @internal This is a specific Backend FormEngine implementation and is not considered part of the Public TYPO3 API.
*/
class RichTextNodeResolver implements NodeResolverInterface
{
......
......@@ -24,7 +24,7 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
/**
* Class to add the canonical tag to the page
*
* @internal
* @internal this class is not part of TYPO3's Core API.
*/
class CanonicalGenerator
{
......
......@@ -18,6 +18,9 @@ namespace TYPO3\CMS\Seo\MetaTag;
use TYPO3\CMS\Core\MetaTag\AbstractMetaTagManager;
/**
* @internal this class is not part of TYPO3's Core API.
*/
class OpenGraphMetaTagManager extends AbstractMetaTagManager
{
/**
......
......@@ -18,6 +18,9 @@ namespace TYPO3\CMS\Seo\MetaTag;
use TYPO3\CMS\Core\MetaTag\AbstractMetaTagManager;
/**
* @internal this class is not part of TYPO3's Core API.
*/
class TwitterCardMetaTagManager extends AbstractMetaTagManager
{
/**
......
......@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\PageTitle\AbstractPageTitleProvider;
/**
* This class will take care of the seo title that can be set in the backend
* @internal this class is not part of TYPO3's Core API.
*/
class SeoTitlePageTitleProvider extends AbstractPageTitleProvider
{
......
......@@ -28,6 +28,7 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
/**
* Class to generate a XML sitemap for pages
* @internal this class is not part of TYPO3's Core API.
*/
class PagesXmlSitemapDataProvider extends AbstractXmlSitemapDataProvider
{
......
......@@ -24,6 +24,7 @@ use TYPO3\CMS\Seo\XmlSitemap\Exception\MissingConfigurationException;
/**
* XmlSiteDataProvider will provide information for the XML sitemap for a specific database table
* @internal this class is not part of TYPO3's Core API.
*/
class RecordsXmlSitemapDataProvider extends AbstractXmlSitemapDataProvider
{
......
......@@ -27,6 +27,7 @@ use TYPO3\CMS\Seo\XmlSitemap\Exception\InvalidConfigurationException;
/**
* Class to render the XML Sitemap to be used as a UserFunction
* @internal this class is not part of TYPO3's Core API.
*/
class XmlSitemapRenderer
{
......
......@@ -42,6 +42,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Script class for the Setup module
*
* @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
*/
class SetupModuleController
{
......
......@@ -18,6 +18,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Class for the list rendering of Web>Task Center module
* @internal
*/
class ActionList extends \TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList
{
......
......@@ -32,6 +32,7 @@ use TYPO3\CMS\Core\Utility\HttpUtility;
/**
* This class provides a task for the taskcenter
* @internal
*/
class ActionTask implements \TYPO3\CMS\Taskcenter\TaskInterface
{
......
......@@ -25,6 +25,7 @@ use TYPO3\CMS\SysAction\ActionTask;
/**
* Adds action links to the backend's toolbar
* @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
*/
class ActionToolbarItem implements ToolbarItemInterface
{
......
......@@ -20,6 +20,7 @@ use TYPO3\CMS\SysNote\Controller\NoteController;
/**
* Hook for the info module
* @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
*/
class InfoModuleHook
{
......
......@@ -21,6 +21,7 @@ use TYPO3\CMS\SysNote\Domain\Repository\SysNoteRepository;
/**
* Hook for the page module
* @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
*/
class PageHook
{
......
......@@ -22,6 +22,7 @@ use TYPO3\CMS\SysNote\Domain\Repository\SysNoteRepository;
/**
* Hook for the list module
* @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
*/
class RecordListHook
{
......
......@@ -17,6 +17,7 @@ namespace TYPO3\CMS\T3editor;
/**
* Represents an addon for CodeMirror
* @internal
*/
class Addon
{
......
......@@ -24,6 +24,7 @@ use TYPO3\CMS\Core\Utility\RootlineUtility;
/**
* Code completion for t3editor
* @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
*/
class CodeCompletionController
{
......
......@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Loads TSref information from a XML file an responds to an AJAX call.
* @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
*/
class TypoScriptReferenceController
{
......
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