Commit e7ac4295 authored by jhodgdon's avatar jhodgdon
Browse files

Issue #1791090 by Ivan Zugec: Remove references to specific admin paths from...

Issue #1791090 by Ivan Zugec: Remove references to specific admin paths from aggregator function docs
parent 2d264b5c
...@@ -13,8 +13,8 @@ ...@@ -13,8 +13,8 @@
/** /**
* Specify the class, title, and short description of your fetcher plugins. * Specify the class, title, and short description of your fetcher plugins.
* *
* The title and the description provided are shown on * The title and the description provided are shown within the
* admin/config/services/aggregator among other places. * configuration page.
* *
* @return * @return
* An associative array whose keys define the fetcher id and whose values * An associative array whose keys define the fetcher id and whose values
...@@ -46,8 +46,8 @@ function hook_aggregator_fetch_info() { ...@@ -46,8 +46,8 @@ function hook_aggregator_fetch_info() {
* 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.
* *
* Modules that define this hook can be set as the active parser on * Modules that define this hook can be set as the active parser within the
* admin/config/services/aggregator. Only one parser can be active at a time. * configuration page. Only one parser can be active at a time.
* *
* @param $feed * @param $feed
* An object describing the resource to be parsed. $feed->source_string * An object describing the resource to be parsed. $feed->source_string
...@@ -90,10 +90,9 @@ function hook_aggregator_parse($feed) { ...@@ -90,10 +90,9 @@ function hook_aggregator_parse($feed) {
/** /**
* Specify the title and short description of your parser. * Specify the title and short description of your parser.
* *
* The title and the description provided are shown on * The title and the description provided are shown within the configuration
* admin/config/services/aggregator among other places. Use as title the human * page. Use as title the human readable name of the parser and as description
* readable name of the parser and as description a brief (40 to 80 characters) * a brief (40 to 80 characters) explanation of the parser's functionality.
* explanation of the parser's functionality.
* *
* This hook is only called if your module implements hook_aggregator_parse(). * This hook is only called if your module implements hook_aggregator_parse().
* If this hook is not implemented aggregator will use your module's file name * If this hook is not implemented aggregator will use your module's file name
...@@ -122,8 +121,8 @@ function hook_aggregator_parse_info() { ...@@ -122,8 +121,8 @@ function hook_aggregator_parse_info() {
* 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.
* *
* Modules that define this hook can be activated as processor on * Modules that define this hook can be activated as a processor within the
* admin/config/services/aggregator. * configuration page.
* *
* @param $feed * @param $feed
* A feed object representing the resource to be processed. $feed->items * A feed object representing the resource to be processed. $feed->items
...@@ -147,10 +146,9 @@ function hook_aggregator_process($feed) { ...@@ -147,10 +146,9 @@ function hook_aggregator_process($feed) {
/** /**
* Specify the title and short description of your processor. * Specify the title and short description of your processor.
* *
* The title and the description provided are shown most importantly on * The title and the description provided are shown within the configuration
* admin/config/services/aggregator. Use as title the natural name of the * page. Use as title the natural name of the processor and as description a
* processor and as description a brief (40 to 80 characters) explanation of the * brief (40 to 80 characters) explanation of the functionality.
* functionality.
* *
* This hook is only called if your module implements hook_aggregator_process(). * This hook is only called if your module implements hook_aggregator_process().
* If this hook is not implemented aggregator will use your module's file name * If this hook is not implemented aggregator will use your module's file name
......
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