From d65f265a6ad137be0db4d8c86879e5123a10087b Mon Sep 17 00:00:00 2001
From: mrmr1993
Date: Tue, 2 Sep 2014 17:43:41 +0100
Subject: Add comments about moving the Vomnibar to an iframe

---
 content_scripts/vomnibar.coffee | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'content_scripts')

diff --git a/content_scripts/vomnibar.coffee b/content_scripts/vomnibar.coffee
index 0e19f194..7b3cfdbe 100644
--- a/content_scripts/vomnibar.coffee
+++ b/content_scripts/vomnibar.coffee
@@ -1,3 +1,6 @@
+#
+# This wraps the vomnibar iframe, which we inject into the page to provide the vomnibar.
+#
 Vomnibar =
   vomnibarElement: null
 
@@ -21,6 +24,11 @@ Vomnibar =
     newTab: true
   }
 
+  # This function opens the vomnibar. It accepts options, a map with the values:
+  #   completer   - The completer to fetch results from.
+  #   query       - Optional. Text to prefill the Vomnibar with.
+  #   selectFirst - Optional, boolean. Whether to select the first entry.
+  #   newTab      - Optional, boolean. Whether to open the result in a new tab.
   open: (options) ->
     unless @vomnibarElement?
       @vomnibarElement = document.createElement "iframe"
-- 
cgit v1.2.3