Merge pull request #163 from NHDaly/documentation

Document the *tools(w) functions
JuliaGizmos · Oct 6, 2018 · d6b2064 · d6b2064
2 parents 5ef89a5 + efb3f26
commit d6b2064
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/src/AtomShell/window.jl b/src/AtomShell/window.jl
@@ -135,12 +135,33 @@ loadurl(win::Window, url) =
 loadfile(win::Window, f) =
   loadurl(win, "file://$f")
 
+"""
+    opentools(win::Window)
+
+Open the Chrome Developer Tools on `win`.
+
+See also: [`closetools`](@ref), [`tools`](@ref)
+"""
 opentools(win::Window) =
   @dot win openDevTools()
 
+"""
+    closetools(win::Window)
+
+Close the Chrome Developer Tools on `win` if open.
+
+See also: [`opentools`](@ref), [`tools`](@ref)
+"""
 closetools(win::Window) =
   @dot win closeDevTools()
 
+"""
+    tools(win::Window)
+
+Toggle the Chrome Developer Tools on `win`.
+
+See also: [`opentools`](@ref), [`closetools`](@ref)
+"""
 tools(win::Window) =
   @dot win toggleDevTools()