Skip to content
Snippets Groups Projects
Commit aee55eef authored by Jacob Wikmark's avatar Jacob Wikmark
Browse files

better docstrings

parent a37d91b3
No related branches found
No related tags found
No related merge requests found
...@@ -18,6 +18,8 @@ function Widget_Container() ...@@ -18,6 +18,8 @@ function Widget_Container()
end end
""" """
getindex_(widget::Widget_Container, s::Symbol)
returns the index of the widget associated with symbol returns the index of the widget associated with symbol
""" """
function getindex_(widget::Widget_Container, s::Symbol) function getindex_(widget::Widget_Container, s::Symbol)
...@@ -25,6 +27,8 @@ function getindex_(widget::Widget_Container, s::Symbol) ...@@ -25,6 +27,8 @@ function getindex_(widget::Widget_Container, s::Symbol)
end end
""" """
Base.getindex(widget::Widget_Container, n::Integer)
returns the widget at the given index or the one associated with given symbol returns the widget at the given index or the one associated with given symbol
""" """
function Base.getindex(widget::Widget_Container, n::Integer) function Base.getindex(widget::Widget_Container, n::Integer)
...@@ -96,6 +100,8 @@ function set!(gui::GUI, data::Array) ...@@ -96,6 +100,8 @@ function set!(gui::GUI, data::Array)
end end
""" """
Base.push!(gui::GUI, value, index::Integer)
Pushes data to the data array(s) to the provided index/indices. Pushes data to the data array(s) to the provided index/indices.
""" """
function Base.push!(gui::GUI, value, index::Integer) function Base.push!(gui::GUI, value, index::Integer)
...@@ -117,6 +123,8 @@ function Base.setindex!(gui::GUI, newval, s::Symbol) ...@@ -117,6 +123,8 @@ function Base.setindex!(gui::GUI, newval, s::Symbol)
end end
""" """
add!(gui::GUI, widgets::Widget_Container)
Add a Widget_Container to the GUI Widget_Container. This makes it possible to access widgets or observables using their associated symbols and ensures the widgets don't time out. Add a Widget_Container to the GUI Widget_Container. This makes it possible to access widgets or observables using their associated symbols and ensures the widgets don't time out.
""" """
function add!(gui::GUI, widgets::Widget_Container) function add!(gui::GUI, widgets::Widget_Container)
...@@ -163,6 +171,8 @@ function has_changed(gui::GUI, s::Array{Symbol, 1}) ...@@ -163,6 +171,8 @@ function has_changed(gui::GUI, s::Array{Symbol, 1})
end end
""" """
animate(gui::GUI, t=0.5)
Usage: animate(gui, t) will periodically update all widgets, that is, call the Usage: animate(gui, t) will periodically update all widgets, that is, call the
listeners of all observables associated with widgets in the gui listeners of all observables associated with widgets in the gui
animate(gui, s::symbol(s)) will periodically update the widget(s) associated with s animate(gui, s::symbol(s)) will periodically update the widget(s) associated with s
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment