From f4dbc994836467dfe9725d733b60baeaa3c13e81 Mon Sep 17 00:00:00 2001
From: Tim van der Meij <timvandermeij@gmail.com>
Date: Tue, 27 Jan 2015 22:54:14 +0100
Subject: [PATCH] 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 f8fcc0498..41995a885 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);