Changeset cd57601

Timestamp:

May 18, 2007, 4:57:46 PM (17 years ago)

Author:

Nelson Elhage <nelhage@mit.edu>

Branches:

master, barnowl_perlaim, debian, release-1.10, release-1.4, release-1.5, release-1.6, release-1.7, release-1.8, release-1.9

Children:

987ff51

Parents:

a695a68

git-author:

Nelson Elhage <nelhage@mit.edu> (05/18/07 16:57:36)

git-committer:

Nelson Elhage <nelhage@mit.edu> (05/18/07 16:57:46)

Message:

Documenting BarnOwl::new_variable_*

File:

• perlwrap.pm (modified) (1 diff)

perlwrap.pm

@@ -79 +79 @@
     BarnOwl::new_command_internal($name, $func, $args{summary}, $args{usage}, $args{description});
 }
+
+=head2 new_variable_int NAME [{ARGS}]
+
+=head2 new_variable_bool NAME [{ARGS}]
+
+=head2 new_variable_string NAME [{ARGS}]
+
+Add a new owl variable, either an int, a bool, or a string, with the
+specified name.
+
+ARGS can optionally contain the following keys:
+
+=over 4
+
+=item default
+
+The default and initial value for the variable
+
+=item summary
+
+A one-line summary of the variable's purpose
+
+=item description
+
+A longer description of the function of the variable
+
+=back
+
+=cut
 
 sub new_variable_int {