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

Improve comments on batching functions.

parent 475305c0
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
......@@ -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.
*/
......
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