[TASK] Mark various parts with phpdoc internal - part 3 30/58530/2
authorBenni Mack <benni@typo3.org>
Mon, 1 Oct 2018 12:55:55 +0000 (14:55 +0200)
committerOliver Hader <oliver.hader@typo3.org>
Mon, 1 Oct 2018 14:06:40 +0000 (16:06 +0200)
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:indexed_search
- EXT:info
- EXT:linkvalidator
- EXT:lowlevel
- EXT:opendocs
- EXT:recordlist
- EXT:recycler
- EXT:redirects
- EXT:reports
- EXT:scheduler

All @api annotations have been removed.

Resolves: #86511
Releases: master
Change-Id: I80de460142266305c1af3ad437f939b7e4448676
Reviewed-on: https://review.typo3.org/58530
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Oliver Hader <oliver.hader@typo3.org>
Tested-by: Oliver Hader <oliver.hader@typo3.org>
97 files changed:
typo3/sysext/indexed_search/Classes/Controller/AdministrationController.php
typo3/sysext/indexed_search/Classes/Controller/SearchController.php
typo3/sysext/indexed_search/Classes/Domain/Repository/AdministrationRepository.php
typo3/sysext/indexed_search/Classes/Domain/Repository/IndexSearchRepository.php
typo3/sysext/indexed_search/Classes/Example/CrawlerHook.php
typo3/sysext/indexed_search/Classes/Example/PluginHook.php
typo3/sysext/indexed_search/Classes/Hook/CrawlerFilesHook.php
typo3/sysext/indexed_search/Classes/Hook/CrawlerHook.php
typo3/sysext/indexed_search/Classes/Hook/TypoScriptFrontendHook.php
typo3/sysext/indexed_search/Classes/Lexer.php
typo3/sysext/indexed_search/Classes/Service/DatabaseSchemaService.php
typo3/sysext/indexed_search/Classes/Utility/DoubleMetaPhoneUtility.php
typo3/sysext/indexed_search/Classes/Utility/IndexedSearchUtility.php
typo3/sysext/indexed_search/Classes/Utility/LikeWildcard.php
typo3/sysext/indexed_search/Classes/ViewHelpers/Format/DateTimeViewHelper.php
typo3/sysext/indexed_search/Classes/ViewHelpers/Format/FlagValueViewHelper.php
typo3/sysext/indexed_search/Classes/ViewHelpers/Format/GroupListViewHelper.php
typo3/sysext/info/Classes/Controller/InfoModuleController.php
typo3/sysext/info/Classes/Controller/InfoPageTyposcriptConfigController.php
typo3/sysext/info/Classes/Controller/PageInformationController.php
typo3/sysext/info/Classes/Controller/TranslationStatusController.php
typo3/sysext/linkvalidator/Classes/LinkAnalyzer.php
typo3/sysext/linkvalidator/Classes/Report/LinkValidatorReport.php
typo3/sysext/linkvalidator/Classes/Task/ValidatorTask.php
typo3/sysext/linkvalidator/Classes/Task/ValidatorTaskAdditionalFieldProvider.php
typo3/sysext/lowlevel/Classes/Controller/ConfigurationController.php
typo3/sysext/lowlevel/Classes/Controller/DatabaseIntegrityController.php
typo3/sysext/lowlevel/Classes/Utility/ArrayBrowser.php
typo3/sysext/opendocs/Classes/Backend/ToolbarItems/OpendocsToolbarItem.php
typo3/sysext/opendocs/Classes/Controller/OpenDocumentController.php
typo3/sysext/opendocs/Classes/Service/OpenDocumentService.php
typo3/sysext/recordlist/Classes/Browser/AbstractElementBrowser.php
typo3/sysext/recordlist/Classes/Browser/DatabaseBrowser.php
typo3/sysext/recordlist/Classes/Browser/FileBrowser.php
typo3/sysext/recordlist/Classes/Browser/FolderBrowser.php
typo3/sysext/recordlist/Classes/Browser/RecordBrowser.php
typo3/sysext/recordlist/Classes/Controller/AbstractLinkBrowserController.php
typo3/sysext/recordlist/Classes/Controller/ElementBrowserController.php
typo3/sysext/recordlist/Classes/Controller/RecordListController.php
typo3/sysext/recordlist/Classes/LinkHandler/AbstractLinkHandler.php
typo3/sysext/recordlist/Classes/LinkHandler/FileLinkHandler.php
typo3/sysext/recordlist/Classes/LinkHandler/FolderLinkHandler.php
typo3/sysext/recordlist/Classes/LinkHandler/MailLinkHandler.php
typo3/sysext/recordlist/Classes/LinkHandler/PageLinkHandler.php
typo3/sysext/recordlist/Classes/LinkHandler/RecordLinkHandler.php
typo3/sysext/recordlist/Classes/LinkHandler/UrlLinkHandler.php
typo3/sysext/recordlist/Classes/RecordList/DatabaseRecordList.php
typo3/sysext/recordlist/Classes/Tree/View/DummyLinkParameterProvider.php
typo3/sysext/recordlist/Classes/Tree/View/ElementBrowserPageTreeView.php
typo3/sysext/recordlist/Classes/Tree/View/RecordBrowserPageTreeView.php
typo3/sysext/recordlist/Classes/View/FolderUtilityRenderer.php
typo3/sysext/recycler/Classes/Controller/DeletedRecordsController.php
typo3/sysext/recycler/Classes/Controller/RecyclerAjaxController.php
typo3/sysext/recycler/Classes/Controller/RecyclerModuleController.php
typo3/sysext/recycler/Classes/Domain/Model/DeletedRecords.php
typo3/sysext/recycler/Classes/Domain/Model/Tables.php
typo3/sysext/recycler/Classes/Task/CleanerFieldProvider.php
typo3/sysext/recycler/Classes/Task/CleanerTask.php
typo3/sysext/recycler/Classes/Utility/RecyclerUtility.php
typo3/sysext/redirects/Classes/Controller/ManagementController.php
typo3/sysext/redirects/Classes/Evaluation/SourceHost.php
typo3/sysext/redirects/Classes/FormDataProvider/ValuePickerItemDataProvider.php
typo3/sysext/redirects/Classes/Hooks/DataHandlerCacheFlushingHook.php
typo3/sysext/redirects/Classes/Http/Middleware/RedirectHandler.php
typo3/sysext/redirects/Classes/Repository/RedirectRepository.php
typo3/sysext/redirects/Classes/Service/UrlService.php
typo3/sysext/redirects/Classes/UserFunctions/HitCountDisplayCondition.php
typo3/sysext/redirects/Classes/ViewHelpers/EditRecordViewHelper.php
typo3/sysext/redirects/Classes/ViewHelpers/TargetPageIdViewHelper.php
typo3/sysext/reports/Classes/Controller/ReportController.php
typo3/sysext/reports/Classes/Task/SystemStatusUpdateTask.php
typo3/sysext/reports/Classes/Task/SystemStatusUpdateTaskNotificationEmailField.php
typo3/sysext/scheduler/Classes/Controller/SchedulerModuleController.php
typo3/sysext/scheduler/Classes/CronCommand/CronCommand.php
typo3/sysext/scheduler/Classes/CronCommand/NormalizeCommand.php
typo3/sysext/scheduler/Classes/Example/SleepTask.php
typo3/sysext/scheduler/Classes/Example/SleepTaskAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Example/TestTask.php
typo3/sysext/scheduler/Classes/Example/TestTaskAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Execution.php
typo3/sysext/scheduler/Classes/Scheduler.php
typo3/sysext/scheduler/Classes/Task/CachingFrameworkGarbageCollectionAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Task/CachingFrameworkGarbageCollectionTask.php
typo3/sysext/scheduler/Classes/Task/ExecuteSchedulableCommandAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Task/ExecuteSchedulableCommandTask.php
typo3/sysext/scheduler/Classes/Task/FileStorageExtractionAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Task/FileStorageExtractionTask.php
typo3/sysext/scheduler/Classes/Task/FileStorageIndexingAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Task/FileStorageIndexingTask.php
typo3/sysext/scheduler/Classes/Task/IpAnonymizationAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Task/IpAnonymizationTask.php
typo3/sysext/scheduler/Classes/Task/OptimizeDatabaseTableAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Task/OptimizeDatabaseTableTask.php
typo3/sysext/scheduler/Classes/Task/RecyclerGarbageCollectionAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Task/RecyclerGarbageCollectionTask.php
typo3/sysext/scheduler/Classes/Task/TableGarbageCollectionAdditionalFieldProvider.php
typo3/sysext/scheduler/Classes/Task/TableGarbageCollectionTask.php

index d1d3503..91cc60c 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3\CMS\IndexedSearch\Indexer;
 
 /**
  * Administration controller
+ * @internal This class is a specific controller implementation and is not considered part of the Public TYPO3 API.
  */
 class AdministrationController extends ActionController
 {
index 3096c76..ef229e5 100644 (file)
@@ -39,6 +39,7 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
  *
  * Creates a search form for indexed search. Indexing must be enabled
  * for this to make sense.
+ * @internal This class is a specific controller implementation and is not considered part of the Public TYPO3 API.
  */
 class SearchController extends \TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 {
index 51decc6..5824023 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3\CMS\IndexedSearch\FileContentParser;
 
 /**
  * Administration repository
+ * @internal This class is a specific repository implementation and is not considered part of the Public TYPO3 API.
  */
 class AdministrationRepository
 {
index e4bc89f..5873d48 100644 (file)
@@ -29,6 +29,7 @@ use TYPO3\CMS\IndexedSearch\Utility;
 
 /**
  * Index search abstraction to search through the index
+ * @internal This class is a specific repository implementation and is not considered part of the Public TYPO3 API.
  */
 class IndexSearchRepository
 {
index 58203f5..096ef1f 100644 (file)
@@ -19,6 +19,7 @@ use TYPO3\CMS\IndexedSearch\Indexer;
 
 /**
  * Index search crawler hook example
+ * @internal just an example, not for public use, but used as a blue-print
  */
 class CrawlerHook
 {
index da0f381..c279f7f 100644 (file)
@@ -21,6 +21,7 @@ namespace TYPO3\CMS\IndexedSearch\Example;
  * Index search frontend - EXAMPLE hook for alternative searching / display etc.
  * Hooks are configured in ext_localconf.php as key => hook-reference pairs in $TYPO3_CONF_VARS['EXTCONF']['indexed_search']['pi1_hooks']. See example in ext_localconf.php for "indexed_search"
  * Each hook must have an entry, the key must match the hook-key in class.tx_indexed_search.php and generally the key equals the function name in the hook object (a convension used)
+ * @internal just an example, not for public use, but used as a blue-print
  */
 class PluginHook
 {
index be60c89..3b762dd 100644 (file)
@@ -18,6 +18,7 @@ namespace TYPO3\CMS\IndexedSearch\Hook;
  * Crawler hook for indexed search. Works with the "crawler" extension
  * This hook is specifically used to index external files found on pages through the crawler extension.
  * @see \TYPO3\CMS\IndexedSearch\Indexer::extractLinks()
+ * @internal this is a TYPO3-internal hook implementation and not part of TYPO3's Core API.
  */
 class CrawlerFilesHook
 {
index 0d2527a..b4611ed 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Core\Utility\RootlineUtility;
 
 /**
  * Crawler hook for indexed search. Works with the "crawler" extension
+ * @internal this is a TYPO3-internal hook implementation and not part of TYPO3's Core API.
  */
 class CrawlerHook
 {
index ffc7da4..7612d00 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 
 /**
  * Hooks for \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController (TSFE).
+ * @internal this is a TYPO3-internal hook implementation and not part of TYPO3's Core API.
  */
 class TypoScriptFrontendHook
 {
index e969af0..0c802c0 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 /**
  * Lexer class for indexed_search
  * A lexer splits the text into words
+ * @internal
  */
 class Lexer
 {
index 9f798ca..b700bb5 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * This service provides the mysql specific changes of the schema definition
+ * @internal this is a TYPO3-internal hook implementation and not part of TYPO3's Core API.
  */
 class DatabaseSchemaService
 {
index bd8ac2a..31612ab 100644 (file)
@@ -18,6 +18,7 @@ namespace TYPO3\CMS\IndexedSearch\Utility;
  * TYPO3: Had to change name to "\TYPO3\CMS\IndexedSearch\Utility\DoubleMetaPhoneUtility" from just "DoubleMetaPhone" because TYPO3 requires a user class to be prefixed so:
  * TYPO3: If you want to use this metaphone method instead of the default in the indexer you can enable it in the extension configuration
  * TYPO3: Of course you can write your own metaphone hook methods by taking this class and configuration as example (also see ext_localconf.php)
+ * @internal
  */
 class DoubleMetaPhoneUtility
 {
index 9a2d206..4bbd842 100644 (file)
@@ -17,6 +17,7 @@ namespace TYPO3\CMS\IndexedSearch\Utility;
 /**
  * Class with common methods used across various classes in the indexed search.
  * Impementation is provided by various people from the TYPO3 community.
+ * @internal
  */
 class IndexedSearchUtility
 {
index 973026e..cf5b232 100644 (file)
@@ -19,6 +19,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Enumeration object for LikeWildcard
+ * @internal
  */
 final class LikeWildcard extends Enumeration
 {
index 2efd65b..357aafb 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * DateTime viewhelper
+ * @internal
  */
 class DateTimeViewHelper extends AbstractViewHelper
 {
index 4cd6de0..2b484f3 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * FlagValue viewhelper
+ * @internal
  */
 class FlagValueViewHelper extends AbstractViewHelper
 {
index a26bacd..2353743 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Group list viewhelper
+ * @internal
  */
 class GroupListViewHelper extends AbstractViewHelper
 {
index b6321ef..d7865b8 100644 (file)
@@ -36,6 +36,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 /**
  * Script Class for the Web > Info module
  * This class creates the framework to which other extensions can connect their sub-modules
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class InfoModuleController
 {
index ec5cac0..352ec11 100644 (file)
@@ -33,6 +33,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Page TSconfig viewer in Web -> Info
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class InfoPageTyposcriptConfigController
 {
index faa70b2..54e65ae 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Class for displaying page information (records, page record properties) in Web -> Info
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class PageInformationController
 {
index 6d08374..74657e7 100644 (file)
@@ -34,6 +34,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Class for displaying translation status of pages in the tree in Web -> Info
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class TranslationStatusController
 {
index c73d6e8..c1bf03a 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * This class provides Processing plugin implementation
+ * @internal
  */
 class LinkAnalyzer
 {
index b154a5a..63a98c9 100644 (file)
@@ -37,6 +37,7 @@ use TYPO3\CMS\Linkvalidator\LinkAnalyzer;
 
 /**
  * Module 'Link validator' as sub module of Web -> Info
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class LinkValidatorReport
 {
index fbff87f..c677134 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Scheduler\Task\AbstractTask;
 
 /**
  * This class provides Scheduler plugin implementation
+ * @internal This class is a specific Scheduler task implementation and is not part of the TYPO3's Core API.
  */
 class ValidatorTask extends AbstractTask
 {
index fc9173f..aae2133 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 
 /**
  * This class provides Scheduler Additional Field plugin implementation
+ * @internal This class is a specific Scheduler task implementation and is not part of the TYPO3's Core API.
  */
 class ValidatorTaskAdditionalFieldProvider extends AbstractAdditionalFieldProvider
 {
index ce666e5..ff486ff 100644 (file)
@@ -34,6 +34,7 @@ use TYPO3\CMS\Lowlevel\Utility\ArrayBrowser;
 
 /**
  * View configuration arrays in the backend
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class ConfigurationController
 {
index 3ca30c6..6fa6325 100644 (file)
@@ -34,6 +34,7 @@ use TYPO3\CMS\Lowlevel\Integrity\DatabaseIntegrityCheck;
 
 /**
  * Script class for the DB int module
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class DatabaseIntegrityController
 {
index add119a..351f534 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\MathUtility;
 /**
  * Class for displaying an array as a tree
  * See the extension 'lowlevel' /config (Backend module 'Tools > Configuration')
+ * @internal just a helper class for internal usage
  */
 class ArrayBrowser
 {
index 095cd33..5121f9d 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Opendocs\Service\OpenDocumentService;
 
 /**
  * Main functionality to render a list of all open documents in the top bar of the TYPO3 Backend
+ * @internal This class is a specific hook implementation and is not part of the TYPO3's Core API.
  */
 class OpendocsToolbarItem implements ToolbarItemInterface
 {
index f124564..f14ad80 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Opendocs\Service\OpenDocumentService;
  * Controller for documents processing
  *
  * Contains AJAX endpoints of the open docs toolbar item click actions
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class OpenDocumentController
 {
index 8cc708e..ab62fdb 100644 (file)
@@ -19,6 +19,7 @@ use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
 
 /**
  * Access to open and recent documents
+ * @internal helper class
  */
 class OpenDocumentService
 {
index c70cf01..4591b52 100644 (file)
@@ -26,6 +26,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * Base class for element browsers
  *
  * NOTE: This class should only be used internally. Extensions must implement the ElementBrowserInterface.
+ * @internal This class is a specific LinkBrowser implementation and is not part of the TYPO3's Core API.
  */
 abstract class AbstractElementBrowser
 {
index af858a2..0da0bde 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface;
 
 /**
  * Showing a page tree and allows you to browse for records
+ * @internal This class is a specific LinkBrowser implementation and is not part of the TYPO3's Core API.
  */
 class DatabaseBrowser extends AbstractElementBrowser implements ElementBrowserInterface, LinkParameterProviderInterface
 {
index 6aa21a4..823d5ee 100644 (file)
@@ -32,6 +32,7 @@ use TYPO3\CMS\Recordlist\View\FolderUtilityRenderer;
 
 /**
  * Browser for files
+ * @internal This class is a specific LinkBrowser implementation and is not part of the TYPO3's Core API.
  */
 class FileBrowser extends AbstractElementBrowser implements ElementBrowserInterface, LinkParameterProviderInterface
 {
index 2d4c3bc..b34a346 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Recordlist\View\FolderUtilityRenderer;
 
 /**
  * Browser for folders
+ * @internal This class is a specific LinkBrowser implementation and is not part of the TYPO3's Core API.
  */
 class FolderBrowser extends AbstractElementBrowser implements ElementBrowserInterface, LinkParameterProviderInterface
 {
index 6a6d5e8..8935029 100644 (file)
@@ -20,6 +20,7 @@ namespace TYPO3\CMS\Recordlist\Browser;
  *
  * Mostly this is about being able to set to some parameters that cannot
  * be set from outside the DatabaseBrowser.
+ * @internal This class is a specific LinkBrowser implementation and is not part of the TYPO3's Core API.
  */
 class RecordBrowser extends DatabaseBrowser
 {
index c559b2a..42541bd 100644 (file)
@@ -29,6 +29,7 @@ use TYPO3\CMS\Recordlist\LinkHandler\LinkHandlerInterface;
 
 /**
  * Script class for the Link Browser window.
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 abstract class AbstractLinkBrowserController
 {
index d68c5c8..878d879 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Recordlist\Browser\ElementBrowserInterface;
 
 /**
  * Script class for the Element Browser window.
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class ElementBrowserController
 {
index 759cabc..35082ed 100644 (file)
@@ -45,6 +45,7 @@ use TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList;
 
 /**
  * Script Class for the Web > List module; rendering the listing of records on a page
+ * @internal This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.
  */
 class RecordListController
 {
index 564c68f..49a06a0 100644 (file)
@@ -23,7 +23,7 @@ use TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController;
 /**
  * Base class for link handlers
  *
- * NOTE: This class should only be used internally. Extensions must implement the LinkHandlerInterface.
+ * @internal This class should only be used internally. Extensions must implement the LinkHandlerInterface.
  */
 abstract class AbstractLinkHandler
 {
index 68cc329..b4c5486 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3\CMS\Recordlist\View\FolderUtilityRenderer;
 
 /**
  * Link handler for files
+ * @internal This class is a specific LinkHandler implementation and is not part of the TYPO3's Core API.
  */
 class FileLinkHandler extends AbstractLinkHandler implements LinkHandlerInterface, LinkParameterProviderInterface
 {
index 07e7962..a775d63 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Link handler for folder links
+ * @internal This class is a specific LinkHandler implementation and is not part of the TYPO3's Core API.
  */
 class FolderLinkHandler extends FileLinkHandler
 {
index cef793c..9b39bc2 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Link handler for email links
+ * @internal This class is a specific LinkHandler implementation and is not part of the TYPO3's Core API.
  */
 class MailLinkHandler extends AbstractLinkHandler implements LinkHandlerInterface
 {
index 5ed20b5..527d9e1 100644 (file)
@@ -29,6 +29,7 @@ use TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface;
 
 /**
  * Link handler for page (and content) links
+ * @internal This class is a specific LinkHandler implementation and is not part of the TYPO3's Core API.
  */
 class PageLinkHandler extends AbstractLinkHandler implements LinkHandlerInterface, LinkParameterProviderInterface
 {
index 3e7807c..cadf093 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Recordlist\Tree\View\RecordBrowserPageTreeView;
 
 /**
  * Link handler for arbitrary database records
+ * @internal This class is a specific LinkHandler implementation and is not part of the TYPO3's Core API.
  */
 class RecordLinkHandler extends AbstractLinkHandler implements LinkHandlerInterface, LinkParameterProviderInterface
 {
index 63c601f..6ad8d64 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Link handler for external URLs
+ * @internal This class is a specific LinkHandler implementation and is not part of the TYPO3's Core API.
  */
 class UrlLinkHandler extends AbstractLinkHandler implements LinkHandlerInterface
 {
index 2f8c401..9b09e43 100644 (file)
@@ -52,6 +52,7 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
 
 /**
  * Class for rendering of Web>List module
+ * @internal This class is a specific TYPO3 Backend implementation and is not part of the TYPO3's Core API.
  */
 class DatabaseRecordList
 {
index 9f741a7..cc63091 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Recordlist\Tree\View;
 
 /**
  * This class is a dummy class used for the FileSystemNavigationFrameController
+ * @internal
  */
 class DummyLinkParameterProvider implements LinkParameterProviderInterface
 {
index 5f558ef..5f20932 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Extension class for the TBE record browser
+ * @internal
  */
 class ElementBrowserPageTreeView extends \TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView
 {
index 45e0d7e..5a8dded 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Specific page tree for the record link handler.
+ * @internal
  */
 class RecordBrowserPageTreeView extends ElementBrowserPageTreeView
 {
index 9c8ff95..a6cf0df 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface;
 
 /**
  * Renders utility forms used in the views for files/folders of Element and Link Browser
+ * @internal
  */
 class FolderUtilityRenderer
 {
index dce3920..15294b4 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Recycler\Utility\RecyclerUtility;
 
 /**
  * Deleted Records View
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class DeletedRecordsController
 {
index bbc6e41..663c15c 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Recycler\Domain\Model\Tables;
 
 /**
  * Controller class for the 'recycler' extension. Handles the AJAX Requests
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class RecyclerAjaxController
 {
index bfc730e..3ca70dc 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Backend Module for the 'recycler' extension.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class RecyclerModuleController
 {
index af37857..4a5511e 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3\CMS\Recycler\Utility\RecyclerUtility;
 
 /**
  * Model class for the 'recycler' extension.
+ * @internal This class is a specific domain model implementation and is not part of the Public TYPO3 API.
  */
 class DeletedRecords
 {
index 0366dc5..63626cd 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Recycler\Utility\RecyclerUtility;
 
 /**
  * Model class for the 'recycler' extension.
+ * @internal This class is a specific domain model implementation and is not part of the Public TYPO3 API.
  */
 class Tables
 {
index 042d6ab..294491f 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 /**
  * A task that should be run regularly that deletes
  * datasets flagged as "deleted" from the DB.
+ * @internal
  */
 class CleanerFieldProvider extends AbstractAdditionalFieldProvider
 {
index 8140f71..8167340 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\Scheduler\Task\AbstractTask;
 /**
  * A task that should be run regularly that deletes deleted
  * datasets from the DB.
+ * @internal This class is a specific scheduler task implementation and is not part of the Public TYPO3 API.
  */
 class CleanerTask extends AbstractTask
 {
index c90eee3..68197e6 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Helper class for the 'recycler' extension.
+ * @internal
  */
 class RecyclerUtility
 {
index d4779d2..4066a2d 100644 (file)
@@ -35,6 +35,7 @@ use TYPO3Fluid\Fluid\View\ViewInterface;
 
 /**
  * Lists all redirects in the TYPO3 Backend as a module
+ * @internal This class is a specific TYPO3 Backend controller implementation and is not part of the Public TYPO3 API.
  */
 class ManagementController
 {
index 0b3f25b..7f19855 100644 (file)
@@ -19,6 +19,7 @@ namespace TYPO3\CMS\Redirects\Evaluation;
 /**
  * Class SourceHost
  * Triggered from DataHandler as TCA formevals hook for validation / sanitation of domain values.
+ * @internal
  */
 class SourceHost
 {
index e383e12..40a5075 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Inject sys_domain records into valuepicker form
+ * @internal
  */
 class ValuePickerItemDataProvider implements FormDataProviderInterface
 {
index 3d7dfe2..a50e0a6 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\Redirects\Service\RedirectCacheService;
 
 /**
  * Ensure to clear the cache entry when a sys_redirect record is modified or deleted
+ * @internal This class is a specific TYPO3 hook implementation and is not part of the Public TYPO3 API.
  */
 class DataHandlerCacheFlushingHook
 {
index 07e2afd..2cef7ad 100644 (file)
@@ -31,6 +31,8 @@ use TYPO3\CMS\Redirects\Service\RedirectService;
 /**
  * Hooks into the frontend request, and checks if a redirect should apply,
  * If so, a redirect response is triggered.
+ *
+ * @internal
  */
 class RedirectHandler implements MiddlewareInterface, LoggerAwareInterface
 {
index 76d8598..3a8b829 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Class for accessing redirect records from the database
+ * @internal
  */
 class RedirectRepository
 {
index eda9f96..c464796 100644 (file)
@@ -21,6 +21,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Service for URL-related data
+ *
+ * @internal
  */
 class UrlService
 {
index 984c438..a90ad73 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Display condition evaluating the feature toggle "redirects.hitCount"
+ * @internal This class is a specific TYPO3 display condition implementation and is not part of the Public TYPO3 API.
  */
 class HitCountDisplayCondition
 {
index baad8f8..5d1e763 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Edit Record ViewHelper
+ * @internal
  * @todo remove once general edit view helper exists
  */
 class EditRecordViewHelper extends AbstractViewHelper
index 32b5496..d208602 100644 (file)
@@ -26,6 +26,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * The target of a redirect can contain a t3://page link.
  * This ViewHelper checks for such a case and returns the Page ID
+ * @internal
  */
 class TargetPageIdViewHelper extends AbstractViewHelper
 {
index bf91ce1..6f9b58a 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3Fluid\Fluid\View\ViewInterface;
 
 /**
  * Reports controller
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ReportController
 {
index c4aad2c..c190636 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Scheduler\Task\AbstractTask;
 
 /**
  * A task that should be run regularly to determine the system's status.
+ * @internal This class is a specific scheduler task implementation and is not considered part of the Public TYPO3 API.
  */
 class SystemStatusUpdateTask extends AbstractTask
 {
index a06bfe9..073b69c 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 /**
  * Additional field to set the notification email address(es) for system health
  * issue notifications.
+ * @internal This class is a specific scheduler task implementation and is not considered part of the Public TYPO3 API.
  */
 class SystemStatusUpdateTaskNotificationEmailField extends AbstractAdditionalFieldProvider
 {
index 62eba3a..a969c0b 100644 (file)
@@ -47,6 +47,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 
 /**
  * Module 'TYPO3 Scheduler administration module' for the 'scheduler' extension.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class SchedulerModuleController
 {
index 1513002..59d9979 100644 (file)
@@ -48,7 +48,6 @@ class CronCommand
      *
      * @param string $cronCommand The cron command can hold any combination documented as valid
      * @param bool|int $timestamp Optional start time, used in unit tests
-     * @api
      */
     public function __construct($cronCommand, $timestamp = false)
     {
@@ -68,7 +67,6 @@ class CronCommand
     /**
      * Calculates the date of the next execution.
      *
-     * @api
      * @throws \RuntimeException
      */
     public function calculateNextValue()
@@ -108,7 +106,6 @@ class CronCommand
     /**
      * Get next timestamp
      *
-     * @api
      * @return int Unix timestamp
      */
     public function getTimestamp()
@@ -121,6 +118,7 @@ class CronCommand
      * a list of comma separated integers or *
      *
      * @return array command sections:
+     * @internal
      */
     public function getCronCommandSections()
     {
index f4f1b0c..c304ad1 100644 (file)
@@ -32,7 +32,6 @@ class NormalizeCommand
      * and consists of five whitespace separated fields, which are either
      * the letter '*' or a sorted, unique comma separated list of integers.
      *
-     * @api
      * @throws \InvalidArgumentException cron command is invalid or out of bounds
      * @param string $cronCommand The cron command to normalize
      * @return string Normalized cron command
index 07e6f2d..fbab27a 100644 (file)
@@ -17,6 +17,7 @@ namespace TYPO3\CMS\Scheduler\Example;
 /**
  * Provides a task that sleeps for some time
  * This is useful for testing parallel executions
+ * @internal This class is an example is not considered part of the Public TYPO3 API.
  */
 class SleepTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask
 {
index 03f07f0..6ef97ab 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 
 /**
  * Additional fields provider class for usage with the Scheduler's sleep task
+ * @internal This class is an example is not considered part of the Public TYPO3 API.
  */
 class SleepTaskAdditionalFieldProvider extends AbstractAdditionalFieldProvider
 {
index 18e940a..652867f 100644 (file)
@@ -19,6 +19,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Provides testing procedures
+ * @internal This class is an example is not considered part of the Public TYPO3 API.
  */
 class TestTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask
 {
index 8cbe69e..9b785fc 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 
 /**
  * Additional fields provider class for usage with the Scheduler's test task
+ * @internal This class is an example is not considered part of the Public TYPO3 API.
  */
 class TestTaskAdditionalFieldProvider extends AbstractAdditionalFieldProvider
 {
index 4c1b3ca..9f0e052 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Scheduler;
 
 /**
  * This class manages the logic of a particular execution of a task
+ * @internal
  */
 class Execution
 {
index 777a4ef..2905bce 100644 (file)
@@ -28,7 +28,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * TYPO3 Scheduler. This class handles scheduling and execution of tasks.
- * Formerly known as "Gabriel TYPO3 arch angel"
  */
 class Scheduler implements SingletonInterface, LoggerAwareInterface
 {
index 2261b31..9f8880d 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 /**
  * Additional BE fields for caching framework garbage collection task.
  * Creates a multi selectbox with all available cache backends to select from.
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class CachingFrameworkGarbageCollectionAdditionalFieldProvider extends AbstractAdditionalFieldProvider
 {
index 5a5fe43..cc0a217 100644 (file)
@@ -20,6 +20,7 @@ namespace TYPO3\CMS\Scheduler\Task;
  * This task finds all configured caching framework caches and
  * calls the garbage collection of a cache if the cache backend
  * is configured to be cleaned.
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class CachingFrameworkGarbageCollectionTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask
 {
index f01a1e4..7c5b99f 100644 (file)
@@ -29,7 +29,7 @@ use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
 use TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder;
 
 /**
- * Class TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandAdditionalFieldProvider
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class ExecuteSchedulableCommandAdditionalFieldProvider implements AdditionalFieldProviderInterface
 {
index 366834e..daccd37 100644 (file)
@@ -23,7 +23,7 @@ use TYPO3\CMS\Core\Localization\LanguageService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
- * Class TYPO3\CMS\Scheduler\Task\ExecuteSchedulableCommandTask
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class ExecuteSchedulableCommandTask extends AbstractTask
 {
index 478812b..83e5648 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
 
 /**
  * Additional BE fields for task which extracts metadata from storage
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class FileStorageExtractionAdditionalFieldProvider implements AdditionalFieldProviderInterface
 {
index a089736..aff88ac 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Scheduler\Task;
 
 /**
  * This task which indexes files in storage
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class FileStorageExtractionTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask
 {
index bad5c84..be8c109 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Scheduler\Task;
 
 /**
  * Additional BE fields for tasks which indexes files in a storage
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class FileStorageIndexingAdditionalFieldProvider implements \TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface
 {
index d504839..de77dc5 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Scheduler\Task;
 
 /**
  * This task tries to find changes in storage and writes them back to DB
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class FileStorageIndexingTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask
 {
index bb583a8..b3f12d2 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 
 /**
  * Additional BE fields for ip address anonymization task.
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class IpAnonymizationAdditionalFieldProvider extends AbstractAdditionalFieldProvider
 {
index b6063a8..3d49d23 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Core\Utility\IpAnonymizationUtility;
  * Available tables must be registered in
  * $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][\TYPO3\CMS\Scheduler\Task\IpAnonymizationTask::class]['options']['tables']
  * See ext_localconf.php of scheduler extension for an example
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class IpAnonymizationTask extends AbstractTask
 {
index 528c60a..b29caa3 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 
 /**
  * Additional BE fields for optimize database table task.
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class OptimizeDatabaseTableAdditionalFieldProvider extends AbstractAdditionalFieldProvider
 {
index 401ab3a..a19aafe 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * This task reorganizes the physical storage of table data and associated index data,
  * to reduce storage space and improve I/O efficiency when accessing the table. The
  * exact changes made to each table depend on the storage engine used by that table.
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class OptimizeDatabaseTableTask extends AbstractTask
 {
index 7e66da5..8604b70 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
  *
  * Creates an integer input field for difference between scheduler run time
  * and file modification time in days to select from.
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class RecyclerGarbageCollectionAdditionalFieldProvider extends AbstractAdditionalFieldProvider
 {
index feef06b..f8fb870 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  *
  * Compatible drivers should be implemented correctly for this. The shipped "local driver"
  * does a "touch()" after the file is moved into the recycler folder.
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class RecyclerGarbageCollectionTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask
 {
index 67de8c8..af1e43b 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
 
 /**
  * Additional BE fields for sys log table garbage collection task.
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class TableGarbageCollectionAdditionalFieldProvider extends AbstractAdditionalFieldProvider
 {
index d849ac7..9d8150a 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * Available tables must be registered in
  * $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][\TYPO3\CMS\Scheduler\Task\TableGarbageCollectionTask::class]['options']['tables']
  * See ext_localconf.php of scheduler extension for an example
+ * @internal This class is a specific scheduler task implementation is not considered part of the Public TYPO3 API.
  */
 class TableGarbageCollectionTask extends AbstractTask
 {