Skip to content
Snippets Groups Projects
Commit 0221b8f8 authored by Alex Barth's avatar Alex Barth
Browse files

Unify comments for fetch() parse() process().

parent b77ce0e3
No related branches found
No related tags found
No related merge requests found
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
class FeedsCSVParser extends FeedsParser { class FeedsCSVParser extends FeedsParser {
/** /**
* Parses a file in CSV format. * Implementation of FeedsParser::parse().
*/ */
public function parse(FeedsImportBatch $batch, FeedsSource $source) { public function parse(FeedsImportBatch $batch, FeedsSource $source) {
...@@ -42,7 +42,7 @@ class FeedsCSVParser extends FeedsParser { ...@@ -42,7 +42,7 @@ class FeedsCSVParser extends FeedsParser {
} }
/** /**
* Override parent::getSourceElement to use only lower keys. * Override parent::getSourceElement() to use only lower keys.
*/ */
public function getSourceElement($item, $element_key) { public function getSourceElement($item, $element_key) {
$element_key = strtolower($element_key); $element_key = strtolower($element_key);
......
...@@ -11,7 +11,7 @@ abstract class FeedsFetcher extends FeedsPlugin { ...@@ -11,7 +11,7 @@ abstract class FeedsFetcher extends FeedsPlugin {
/** /**
* Fetch content from a source and return it. * Fetch content from a source and return it.
* *
* Stub method. Every class that extends FeedsFetcher must implement this method. * Every class that extends FeedsFetcher must implement this method.
* *
* @param $source * @param $source
* Source value as entered by user through sourceForm(). * Source value as entered by user through sourceForm().
......
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
class FeedsFileFetcher extends FeedsFetcher { class FeedsFileFetcher extends FeedsFetcher {
/** /**
* Fetch a local resource. * Implementation of FeedsFetcher::fetch().
*/ */
public function fetch(FeedsSource $source) { public function fetch(FeedsSource $source) {
$source_config = $source->getConfigFor($this); $source_config = $source->getConfigFor($this);
......
...@@ -12,13 +12,7 @@ ...@@ -12,13 +12,7 @@
class FeedsHTTPFetcher extends FeedsFetcher { class FeedsHTTPFetcher extends FeedsFetcher {
/** /**
* Fetch a resource via http. * Implementation of FeedsFetcher::fetch().
*
* @param $resource
* A resource description of type FeedsResource.
*
* @return
* A string from the requested location if successful, or FALSE if not.
*/ */
public function fetch(FeedsSource $source) { public function fetch(FeedsSource $source) {
$source_config = $source->getConfigFor($this); $source_config = $source->getConfigFor($this);
......
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
class FeedsOPMLParser extends FeedsParser { class FeedsOPMLParser extends FeedsParser {
/** /**
* Parses an RSS/Atom formatted string. * Implementation of FeedsParser::parse().
*/ */
public function parse(FeedsImportBatch $batch, FeedsSource $source) { public function parse(FeedsImportBatch $batch, FeedsSource $source) {
feeds_include_library('opml_parser.inc', 'opml_parser'); feeds_include_library('opml_parser.inc', 'opml_parser');
......
...@@ -9,7 +9,7 @@ abstract class FeedsParser extends FeedsPlugin { ...@@ -9,7 +9,7 @@ abstract class FeedsParser extends FeedsPlugin {
/** /**
* Parse content fetched by fetcher. * Parse content fetched by fetcher.
* *
* Stub method. Extending classes must implement this method. * Extending classes must implement this method.
* *
* @param $batch * @param $batch
* FeedsImportBatch returned by fetcher. * FeedsImportBatch returned by fetcher.
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
class FeedsSimplePieParser extends FeedsParser { class FeedsSimplePieParser extends FeedsParser {
/** /**
* Parses a string in RSS/Atom format. * Implementation of FeedsParser::parse().
*/ */
public function parse(FeedsImportBatch $batch, FeedsSource $source) { public function parse(FeedsImportBatch $batch, FeedsSource $source) {
feeds_include_library('simplepie.inc', 'simplepie'); feeds_include_library('simplepie.inc', 'simplepie');
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
class FeedsSyndicationParser extends FeedsParser { class FeedsSyndicationParser extends FeedsParser {
/** /**
* Parses a string in RSS/Atom format. * Implementation of FeedsParser::parse().
*/ */
public function parse(FeedsImportBatch $batch, FeedsSource $source) { public function parse(FeedsImportBatch $batch, FeedsSource $source) {
feeds_include_library('common_syndication_parser.inc', 'common_syndication_parser'); feeds_include_library('common_syndication_parser.inc', 'common_syndication_parser');
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment