[Pkg-javascript-commits] [pdf.js] 83/116: Add JSDoc comments to PDFOutlineView

[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 f4dbc994836467dfe9725d733b60baeaa3c13e81
Author: Tim van der Meij <timvandermeij at gmail.com>
Date:   Tue Jan 27 22:54:14 2015 +0100

    Add JSDoc comments to PDFOutlineView
---
 web/pdf_outline_view.js | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/web/pdf_outline_view.js b/web/pdf_outline_view.js
index f8fcc04..41995a8 100644
--- a/web/pdf_outline_view.js
+++ b/web/pdf_outline_view.js
@@ -17,7 +17,21 @@
 
 'use strict';
 
+/**
+ * @typedef {Object} PDFOutlineViewOptions
+ * @property {HTMLDivElement} container - The viewer element.
+ * @property {Array} outline - An array of outline objects.
+ * @property {IPDFLinkService} linkService - The navigation/linking service.
+ */
+
+/**
+ * @class
+ */
 var PDFOutlineView = (function PDFOutlineViewClosure() {
+  /**
+   * @constructs PDFOutlineView
+   * @param {PDFOutlineViewOptions} options
+   */
   function PDFOutlineView(options) {
     this.container = options.container;
     this.outline = options.outline;
@@ -32,6 +46,9 @@ var PDFOutlineView = (function PDFOutlineViewClosure() {
       }
     },
 
+    /**
+     * @private
+     */
     _bindLink: function PDFOutlineView_bindLink(element, item) {
       var linkService = this.linkService;
       element.href = linkService.getDestinationHash(item.dest);

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