Commit c9fd3977 authored by jhodgdon's avatar jhodgdon
Browse files

Issue #2290251 by er.pushpinderrana, amitgoyal, ParisLiakos, joshi.rohit100:...

Issue #2290251 by er.pushpinderrana, amitgoyal, ParisLiakos, joshi.rohit100: Make Aggregator plugin developer info more discoverable
parent f751d134
...@@ -12,6 +12,15 @@ ...@@ -12,6 +12,15 @@
/** /**
* Defines a Plugin annotation object for aggregator fetcher plugins. * Defines a Plugin annotation object for aggregator fetcher plugins.
* *
* Plugin Namespace: Plugin\aggregator\fetcher
*
* For a working example, see \Drupal\aggregator\Plugin\aggregator\fetcher\DefaultFetcher
*
* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
* @see \Drupal\aggregator\Plugin\FetcherInterface
* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
* @see plugin_api
*
* @Annotation * @Annotation
*/ */
class AggregatorFetcher extends Plugin { class AggregatorFetcher extends Plugin {
......
...@@ -12,6 +12,15 @@ ...@@ -12,6 +12,15 @@
/** /**
* Defines a Plugin annotation object for aggregator parser plugins. * Defines a Plugin annotation object for aggregator parser plugins.
* *
* Plugin Namespace: Plugin\aggregator\parser
*
* For a working example, see \Drupal\aggregator\Plugin\aggregator\parser\DefaultParser
*
* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
* @see \Drupal\aggregator\Plugin\ParserInterface
* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
* @see plugin_api
*
* @Annotation * @Annotation
*/ */
class AggregatorParser extends Plugin { class AggregatorParser extends Plugin {
......
...@@ -12,6 +12,15 @@ ...@@ -12,6 +12,15 @@
/** /**
* Defines a Plugin annotation object for aggregator processor plugins. * Defines a Plugin annotation object for aggregator processor plugins.
* *
* Plugin Namespace: Plugin\aggregator\processor
*
* For a working example, see \Drupal\aggregator\Plugin\aggregator\processor\DefaultProcessor
*
* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
* @see \Drupal\aggregator\Plugin\ProcessorInterface
* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
* @see plugin_api
*
* @Annotation * @Annotation
*/ */
class AggregatorProcessor extends Plugin { class AggregatorProcessor extends Plugin {
......
...@@ -13,6 +13,15 @@ ...@@ -13,6 +13,15 @@
/** /**
* Manages aggregator plugins. * Manages aggregator plugins.
*
* @see \Drupal\aggregator\Annotation\AggregatorParser
* @see \Drupal\aggregator\Annotation\AggregatorFetcher
* @see \Drupal\aggregator\Annotation\AggregatorProcessor
* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
* @see \Drupal\aggregator\Plugin\FetcherInterface
* @see \Drupal\aggregator\Plugin\ProcessorInterface
* @see \Drupal\aggregator\Plugin\ParserInterface
* @see plugin_api
*/ */
class AggregatorPluginManager extends DefaultPluginManager { class AggregatorPluginManager extends DefaultPluginManager {
......
...@@ -13,6 +13,15 @@ ...@@ -13,6 +13,15 @@
/** /**
* Base class for aggregator plugins that implement settings forms. * Base class for aggregator plugins that implement settings forms.
*
* @see \Drupal\aggregator\Annotation\AggregatorParser
* @see \Drupal\aggregator\Annotation\AggregatorFetcher
* @see \Drupal\aggregator\Annotation\AggregatorProcessor
* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
* @see \Drupal\aggregator\Plugin\FetcherInterface
* @see \Drupal\aggregator\Plugin\ProcessorInterface
* @see \Drupal\aggregator\Plugin\ParserInterface
* @see plugin_api
*/ */
abstract class AggregatorPluginSettingsBase extends PluginBase implements PluginFormInterface, ConfigurablePluginInterface { abstract class AggregatorPluginSettingsBase extends PluginBase implements PluginFormInterface, ConfigurablePluginInterface {
......
...@@ -17,6 +17,11 @@ ...@@ -17,6 +17,11 @@
* active fetcher; second, it is converted to a common format by the active * active fetcher; second, it is converted to a common format by the active
* parser; and finally, it is passed to all active processors, which manipulate * parser; and finally, it is passed to all active processors, which manipulate
* or store the data. * or store the data.
*
* @see \Drupal\aggregator\Annotation\AggregatorFetcher
* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
* @see plugin_api
*/ */
interface FetcherInterface { interface FetcherInterface {
......
...@@ -18,6 +18,10 @@ ...@@ -18,6 +18,10 @@
* active parser; and finally, it is passed to all active processors which * active parser; and finally, it is passed to all active processors which
* manipulate or store the data. * manipulate or store the data.
* *
* @see \Drupal\aggregator\Annotation\AggregatorParser
* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
* @see plugin_api
*/ */
interface ParserInterface { interface ParserInterface {
......
...@@ -17,6 +17,11 @@ ...@@ -17,6 +17,11 @@
* active fetcher; second, it is converted to a common format by the active * active fetcher; second, it is converted to a common format by the active
* parser; and finally, it is passed to all active processors that manipulate or * parser; and finally, it is passed to all active processors that manipulate or
* store the data. * store the data.
*
* @see \Drupal\aggregator\Annotation\AggregatorProcessor
* @see \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase
* @see \Drupal\aggregator\Plugin\AggregatorPluginManager
* @see plugin_api
*/ */
interface ProcessorInterface { interface ProcessorInterface {
......
Markdown is supported
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