Commit 77a2c8f6 authored by Benni Mack's avatar Benni Mack Committed by Oliver Hader
Browse files

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

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's avatarWouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
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>
parent 6a562065
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -19,6 +19,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Enumeration object for LikeWildcard
* @internal
*/
final class LikeWildcard extends Enumeration
{
......
......@@ -21,6 +21,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
/**
* DateTime viewhelper
* @internal
*/
class DateTimeViewHelper extends AbstractViewHelper
{
......
......@@ -20,6 +20,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
/**
* FlagValue viewhelper
* @internal
*/
class FlagValueViewHelper extends AbstractViewHelper
{
......
......@@ -20,6 +20,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
/**
* Group list viewhelper
* @internal
*/
class GroupListViewHelper extends AbstractViewHelper
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
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