From 64d95bedaad1bad62b634da618d7cfc641ac88fa Mon Sep 17 00:00:00 2001
From: Jonas Jenwald <jonas.jenwald@gmail.com>
Date: Thu, 28 Aug 2014 14:11:14 +0200
Subject: [PATCH] In src/display/api.js, add documentation for the
 |progressCallback| parameter in |PDFJS.getDocument|

---
 src/display/api.js | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/display/api.js b/src/display/api.js
index a2d98239c99ae..9850c0dc8153a 100644
--- a/src/display/api.js
+++ b/src/display/api.js
@@ -191,6 +191,11 @@ PDFJS.maxCanvasPixels = (PDFJS.maxCanvasPixels === undefined ?
  * parameters: function that needs to be called with new password and reason
  * (see {PasswordResponses}).
  *
+ * @param {function} progressCallback is optional. It is used to be able to
+ * monitor the loading progress of the PDF file (necessary to implement e.g.
+ * a loading bar). The callback receives an {Object} with the properties:
+ * {number} loaded and {number} total.
+ *
  * @return {Promise} A promise that is resolved with {@link PDFDocumentProxy}
  *   object.
  */