From a1d8f5657dabb3aebbfc4ef357c2c9c5937f5b24 Mon Sep 17 00:00:00 2001
From: Alex Barth <alex_b@53995.no-reply.drupal.org>
Date: Sat, 27 Feb 2010 02:51:19 +0000
Subject: [PATCH] Improve comments on batching functions.
---
includes/FeedsImporter.inc | 4 ++--
includes/FeedsSource.inc | 8 ++++++++
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/includes/FeedsImporter.inc b/includes/FeedsImporter.inc
index f6d782cb..652eaffd 100644
--- a/includes/FeedsImporter.inc
+++ b/includes/FeedsImporter.inc
@@ -68,8 +68,8 @@ class FeedsImporter extends FeedsConfigurable {
* given, internal processor settings will be used.
*
* @return
- * FEEDS_BATCH_COMPLETE if complete, a float between 0 and 1 indicating
- * progress otherwise.
+ * FEEDS_BATCH_COMPLETE if the expiry process finished. A decimal between
+ * 0.0 and 0.9 periodic if expiry is still in progress.
*
* @throws
* Throws Exception if an error occurs when expiring items.
diff --git a/includes/FeedsSource.inc b/includes/FeedsSource.inc
index 3c6ab557..fe0760e1 100644
--- a/includes/FeedsSource.inc
+++ b/includes/FeedsSource.inc
@@ -116,6 +116,10 @@ class FeedsSource extends FeedsConfigurable {
* Lock a source before importing by using FeedsSource::lock(), after
* importing, release with FeedsSource::release().
*
+ * @return
+ * FEEDS_BATCH_COMPLETE if the import process finished. A decimal between
+ * 0.0 and 0.9 periodic if import is still in progress.
+ *
* @throws
* Throws Exception if an error occurs when importing.
*/
@@ -143,6 +147,10 @@ class FeedsSource extends FeedsConfigurable {
/**
* Remove all items from a feed.
*
+ * @return
+ * FEEDS_BATCH_COMPLETE if the clearing process finished. A decimal between
+ * 0.0 and 0.9 periodic if clearing is still in progress.
+ *
* @throws
* Throws Exception if an error occurs when clearing.
*/
--
GitLab