[Pkg-javascript-commits] [pdf.js] 17/204: In src/display/api.js, add documentation for the |progressCallback| parameter in |PDFJS.getDocument|

[David Prévot]

This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository pdf.js.

commit 64d95bedaad1bad62b634da618d7cfc641ac88fa
Author: Jonas Jenwald <jonas.jenwald at gmail.com>
Date:   Thu Aug 28 14:11:14 2014 +0200

    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 a2d9823..9850c0d 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.
  */

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/pdf.js.git