[MediaWiki-commits] [Gerrit] Add some doc comments - change (mediawiki...OfflineContentGenerator)

2014-07-25 Thread Mwalker (Code Review) 
Mwalker has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/149453

Change subject: Add some doc comments
..

Add some doc comments

Change-Id: Ib0fa39127488221a07fe62c2fec60df363fb2dac
---
M lib/threads/backend.js
1 file changed, 24 insertions(+), 0 deletions(-)


  git pull 
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Collection/OfflineContentGenerator
 refs/changes/53/149453/1

diff --git a/lib/threads/backend.js b/lib/threads/backend.js
index 2eaba88..e930226 100644
--- a/lib/threads/backend.js
+++ b/lib/threads/backend.js
@@ -128,6 +128,10 @@
 }
 
 /* === Private Functions === */
+/**
+ * Async loop that forms the top of the job. Pulls items from Redis and
+ * then starts the promise chain to bundle, render, and cleanup.
+ */
 function getNewItemFromQueue() {
redisClient.blpop( config.redis.job_queue_name, 0 )
.then( function( result ) {
@@ -170,6 +174,11 @@
.done();
 }
 
+/**
+ * Take a status object from getNewItemFromQueue and render it
+ * @param {string} obj JSON string representing a job status object
+ * @returns {promise}
+ */
 function newItemFromQueue( obj ) {
var jobDetails;
var metabookFile, bundleFile, renderedFile;
@@ -287,6 +296,14 @@
} );
 }
 
+/**
+ * Fork the bundler process and resolve the promise when done
+ *
+ * @param jobDetails
+ * @param metabookPath
+ * @param bundleFile
+ * @returns {promise|Deferred.promise|o.A.n.promise|PromiseCapability.promise}
+ */
 function runBundler( jobDetails, metabookPath, bundleFile ) {
var child, killTimer,
startTime = Date.now(),
@@ -382,6 +399,13 @@
return p.promise;
 }
 
+/**
+ * For the appropriate renderer and resolve the promise when done
+ *
+ * @param jobDetails
+ * @param bundleFile
+ * @returns {promise}
+ */
 function runRenderer( jobDetails, bundleFile ) {
var child, killTimer,
startTime = Date.now(),

-- 
To view, visit https://gerrit.wikimedia.org/r/149453
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib0fa39127488221a07fe62c2fec60df363fb2dac
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Collection/OfflineContentGenerator
Gerrit-Branch: master
Gerrit-Owner: Mwalker mwal...@wikimedia.org

___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

[MediaWiki-commits] [Gerrit] Add some doc comments - change (mediawiki...OfflineContentGenerator)

2014-07-25 Thread jenkins-bot (Code Review) 
jenkins-bot has submitted this change and it was merged.

Change subject: Add some doc comments
..


Add some doc comments

Change-Id: Ib0fa39127488221a07fe62c2fec60df363fb2dac
---
M lib/threads/backend.js
1 file changed, 24 insertions(+), 0 deletions(-)

Approvals:
  Mwalker: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/lib/threads/backend.js b/lib/threads/backend.js
index 2eaba88..e930226 100644
--- a/lib/threads/backend.js
+++ b/lib/threads/backend.js
@@ -128,6 +128,10 @@
 }
 
 /* === Private Functions === */
+/**
+ * Async loop that forms the top of the job. Pulls items from Redis and
+ * then starts the promise chain to bundle, render, and cleanup.
+ */
 function getNewItemFromQueue() {
redisClient.blpop( config.redis.job_queue_name, 0 )
.then( function( result ) {
@@ -170,6 +174,11 @@
.done();
 }
 
+/**
+ * Take a status object from getNewItemFromQueue and render it
+ * @param {string} obj JSON string representing a job status object
+ * @returns {promise}
+ */
 function newItemFromQueue( obj ) {
var jobDetails;
var metabookFile, bundleFile, renderedFile;
@@ -287,6 +296,14 @@
} );
 }
 
+/**
+ * Fork the bundler process and resolve the promise when done
+ *
+ * @param jobDetails
+ * @param metabookPath
+ * @param bundleFile
+ * @returns {promise|Deferred.promise|o.A.n.promise|PromiseCapability.promise}
+ */
 function runBundler( jobDetails, metabookPath, bundleFile ) {
var child, killTimer,
startTime = Date.now(),
@@ -382,6 +399,13 @@
return p.promise;
 }
 
+/**
+ * For the appropriate renderer and resolve the promise when done
+ *
+ * @param jobDetails
+ * @param bundleFile
+ * @returns {promise}
+ */
 function runRenderer( jobDetails, bundleFile ) {
var child, killTimer,
startTime = Date.now(),

-- 
To view, visit https://gerrit.wikimedia.org/r/149453
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Ib0fa39127488221a07fe62c2fec60df363fb2dac
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Collection/OfflineContentGenerator
Gerrit-Branch: master
Gerrit-Owner: Mwalker mwal...@wikimedia.org
Gerrit-Reviewer: Mwalker mwal...@wikimedia.org
Gerrit-Reviewer: jenkins-bot 

___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits