From ed59bfd83f1c7912380b52b4dba2160534aa9226 Mon Sep 17 00:00:00 2001
From: Alex Barth <alex_b@53995.no-reply.drupal.org>
Date: Tue, 23 Feb 2010 23:57:26 +0000
Subject: [PATCH] Improve importer documentation.
---
includes/FeedsImporter.inc | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/includes/FeedsImporter.inc b/includes/FeedsImporter.inc
index a4c6f7a0..a37509da 100644
--- a/includes/FeedsImporter.inc
+++ b/includes/FeedsImporter.inc
@@ -16,15 +16,16 @@ define('FEEDS_BATCH_COMPLETE', 1);
define('FEEDS_BATCH_ACTIVE', 0);
/**
- * Class defining an importer object. This is the main hub for Feeds module's
- * functionality.
+ * A FeedsImporter object describes how an external source should be fetched,
+ * parsed and processed. Feeds can manage an arbitrary amount of importers.
*
- * A FeedsImporter holds a pointer to a fetcher, a parser and a processor
- * plugin. It further contains the configuration for itself and each of the
- * three plugins.
+ * A FeedsImporter holds a pointer to a FeedsFetcher, a FeedsParser and a
+ * FeedsProcessor plugin. It further contains the configuration for itself and
+ * each of the three plugins.
*
- * Its most important responsibilities are configuration management and expiring
- * of all items produced by this importer.
+ * Its most important responsibilities are configuration management, interfacing
+ * with FeedsScheduler class and expiring of all items produced by this
+ * importer.
*
* When a FeedsImporter is instantiated, it loads its configuration. Then it
* instantiates one fetcher, one parser and one processor plugin depending on
--
GitLab