From aee55eef13c474f004ac3e15f71ee960744a5810 Mon Sep 17 00:00:00 2001
From: jwikmark <jacob@wikmark.se>
Date: Wed, 14 Mar 2018 15:01:53 +0100
Subject: [PATCH] better docstrings
---
src/gui.jl | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/src/gui.jl b/src/gui.jl
index 79a4815..2033186 100644
--- a/src/gui.jl
+++ b/src/gui.jl
@@ -18,6 +18,8 @@ function Widget_Container()
end
"""
+getindex_(widget::Widget_Container, s::Symbol)
+
returns the index of the widget associated with symbol
"""
function getindex_(widget::Widget_Container, s::Symbol)
@@ -25,6 +27,8 @@ function getindex_(widget::Widget_Container, s::Symbol)
end
"""
+Base.getindex(widget::Widget_Container, n::Integer)
+
returns the widget at the given index or the one associated with given symbol
"""
function Base.getindex(widget::Widget_Container, n::Integer)
@@ -96,6 +100,8 @@ function set!(gui::GUI, data::Array)
end
"""
+Base.push!(gui::GUI, value, index::Integer)
+
Pushes data to the data array(s) to the provided index/indices.
"""
function Base.push!(gui::GUI, value, index::Integer)
@@ -117,6 +123,8 @@ function Base.setindex!(gui::GUI, newval, s::Symbol)
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.
"""
function add!(gui::GUI, widgets::Widget_Container)
@@ -163,6 +171,8 @@ function has_changed(gui::GUI, s::Array{Symbol, 1})
end
"""
+animate(gui::GUI, t=0.5)
+
Usage: animate(gui, t) will periodically update all widgets, that is, call the
listeners of all observables associated with widgets in the gui
animate(gui, s::symbol(s)) will periodically update the widget(s) associated with s
--
GitLab