Changeset 6deb32b

Timestamp:

Aug 5, 2017, 5:54:41 PM (7 years ago)

Author:

Jason Gross <jgross@mit.edu>

Parents:

1f92f39

git-author:

Jason Gross <jgross@mit.edu> (05/27/13 16:44:23)

git-committer:

Jason Gross <jgross@mit.edu> (08/05/17 17:54:41)

Message:

Describe get_variable_info

File:

• perl/lib/BarnOwl.pm (modified) (2 diffs)

perl/lib/BarnOwl.pm

@@ -16 +16 @@
                     create_style getnumcolors wordwrap
                     message_matches_filter
+                    get_variable_info
                     add_dispatch remove_dispatch
                     add_io_dispatch remove_io_dispatch
@@ -249 +250 @@
 C<QUIET> is false, this method displays an error message if
 if C<FILTER_NAME> does not name a valid filter.
+
+=head2 get_variable_info VARIABLE_NAME
+
+Returns a hash with the following keys, describing the variable named:
+
+=over
+
+=item name
+
+=item description
+
+=item summary
+
+=item validsettings
+
+=item takes_on_off
+
+=back
+
+Fails if C<VARIABLE_NAME> does not name a valid variable.
 
 =head2 add_dispatch FD CALLBACK