From 0221b8f8cbd40ae6a41f68693b87f9e9fa763b71 Mon Sep 17 00:00:00 2001
From: Alex Barth <alex_b@53995.no-reply.drupal.org>
Date: Sun, 20 Dec 2009 23:54:44 +0000
Subject: [PATCH] Unify comments for fetch() parse() process().

---
 plugins/FeedsCSVParser.inc         | 4 ++--
 plugins/FeedsFetcher.inc           | 2 +-
 plugins/FeedsFileFetcher.inc       | 2 +-
 plugins/FeedsHTTPFetcher.inc       | 8 +-------
 plugins/FeedsOPMLParser.inc        | 2 +-
 plugins/FeedsParser.inc            | 2 +-
 plugins/FeedsSimplePieParser.inc   | 2 +-
 plugins/FeedsSyndicationParser.inc | 2 +-
 8 files changed, 9 insertions(+), 15 deletions(-)

diff --git a/plugins/FeedsCSVParser.inc b/plugins/FeedsCSVParser.inc
index 5e34da05..2c99c5f8 100644
--- a/plugins/FeedsCSVParser.inc
+++ b/plugins/FeedsCSVParser.inc
@@ -7,7 +7,7 @@
 class FeedsCSVParser extends FeedsParser {
 
   /**
-   * Parses a file in CSV format.
+   * Implementation of FeedsParser::parse().
    */
   public function parse(FeedsImportBatch $batch, FeedsSource $source) {
 
@@ -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) {
     $element_key = strtolower($element_key);
diff --git a/plugins/FeedsFetcher.inc b/plugins/FeedsFetcher.inc
index a70d52ea..229989ef 100644
--- a/plugins/FeedsFetcher.inc
+++ b/plugins/FeedsFetcher.inc
@@ -11,7 +11,7 @@ abstract class FeedsFetcher extends FeedsPlugin {
   /**
    * 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
    *   Source value as entered by user through sourceForm().
diff --git a/plugins/FeedsFileFetcher.inc b/plugins/FeedsFileFetcher.inc
index b8d8558b..85507dce 100644
--- a/plugins/FeedsFileFetcher.inc
+++ b/plugins/FeedsFileFetcher.inc
@@ -12,7 +12,7 @@
 class FeedsFileFetcher extends FeedsFetcher {
 
   /**
-   * Fetch a local resource.
+   * Implementation of FeedsFetcher::fetch().
    */
   public function fetch(FeedsSource $source) {
     $source_config = $source->getConfigFor($this);
diff --git a/plugins/FeedsHTTPFetcher.inc b/plugins/FeedsHTTPFetcher.inc
index 7feb16a4..dda77f96 100644
--- a/plugins/FeedsHTTPFetcher.inc
+++ b/plugins/FeedsHTTPFetcher.inc
@@ -12,13 +12,7 @@
 class FeedsHTTPFetcher extends FeedsFetcher {
 
   /**
-   * Fetch a resource via http.
-   *
-   * @param $resource
-   *   A resource description of type FeedsResource.
-   *
-   * @return
-   *   A string from the requested location if successful, or FALSE if not.
+   * Implementation of FeedsFetcher::fetch().
    */
   public function fetch(FeedsSource $source) {
     $source_config = $source->getConfigFor($this);
diff --git a/plugins/FeedsOPMLParser.inc b/plugins/FeedsOPMLParser.inc
index e581932b..547f6360 100644
--- a/plugins/FeedsOPMLParser.inc
+++ b/plugins/FeedsOPMLParser.inc
@@ -12,7 +12,7 @@
 class FeedsOPMLParser extends FeedsParser {
 
   /**
-   * Parses an RSS/Atom formatted string.
+   * Implementation of FeedsParser::parse().
    */
   public function parse(FeedsImportBatch $batch, FeedsSource $source) {
     feeds_include_library('opml_parser.inc', 'opml_parser');
diff --git a/plugins/FeedsParser.inc b/plugins/FeedsParser.inc
index fda63183..d4340a28 100644
--- a/plugins/FeedsParser.inc
+++ b/plugins/FeedsParser.inc
@@ -9,7 +9,7 @@ abstract class FeedsParser extends FeedsPlugin {
   /**
    * Parse content fetched by fetcher.
    *
-   * Stub method. Extending classes must implement this method.
+   * Extending classes must implement this method.
    *
    * @param $batch
    *   FeedsImportBatch returned by fetcher.
diff --git a/plugins/FeedsSimplePieParser.inc b/plugins/FeedsSimplePieParser.inc
index 601aaa6a..f5b97ef6 100644
--- a/plugins/FeedsSimplePieParser.inc
+++ b/plugins/FeedsSimplePieParser.inc
@@ -9,7 +9,7 @@
 class FeedsSimplePieParser extends FeedsParser {
 
   /**
-   * Parses a string in RSS/Atom format.
+   * Implementation of FeedsParser::parse().
    */
   public function parse(FeedsImportBatch $batch, FeedsSource $source) {
     feeds_include_library('simplepie.inc', 'simplepie');
diff --git a/plugins/FeedsSyndicationParser.inc b/plugins/FeedsSyndicationParser.inc
index 8dddacf2..1561bce2 100644
--- a/plugins/FeedsSyndicationParser.inc
+++ b/plugins/FeedsSyndicationParser.inc
@@ -9,7 +9,7 @@
 class FeedsSyndicationParser extends FeedsParser {
 
   /**
-   * Parses a string in RSS/Atom format.
+   * Implementation of FeedsParser::parse().
    */
   public function parse(FeedsImportBatch $batch, FeedsSource $source) {
     feeds_include_library('common_syndication_parser.inc', 'common_syndication_parser');
-- 
GitLab