[611] in BarnOwl Developers

home help back first fref pref prev next nref lref last post

[D-O-H] r714 - / trunk/owl

daemon@ATHENA.MIT.EDU (nelhage@MIT.EDU)
Thu Oct 29 18:07:56 2009

Resent-From: nelhage@mit.edu
Resent-To: barnowl-dev-mtg@charon.mit.edu
To: dirty-owl-hackers@mit.edu
From: nelhage@MIT.EDU
Reply-to: dirty-owl-hackers@MIT.EDU
Date: Fri, 18 May 2007 16:57:46 -0400 (EDT)

Author: nelhage
Date: 2007-05-18 16:57:46 -0400 (Fri, 18 May 2007)
New Revision: 714

Modified:
   /
   trunk/owl/perlwrap.pm
Log:
 r21975@phanatique:  nelhage | 2007-05-18 16:57:36 -0400
 Documenting BarnOwl::new_variable_*
 



Property changes on: 
___________________________________________________________________
Name: svk:merge
   - 6122c8b4-0e12-0410-9533-8bcd7c66c992:/local/dirty-owl-hacks:24493
6aa88b72-b502-0410-8cb4-a5dd0230fb79:/owl-local:1356
bb873fd7-8e23-0410-944a-99ec44c633eb:/local/barnowl:21973
bb873fd7-8e23-0410-944a-99ec44c633eb:/local/d-o-h:18636
   + 6122c8b4-0e12-0410-9533-8bcd7c66c992:/local/dirty-owl-hacks:24493
6aa88b72-b502-0410-8cb4-a5dd0230fb79:/owl-local:1356
bb873fd7-8e23-0410-944a-99ec44c633eb:/local/barnowl:21975
bb873fd7-8e23-0410-944a-99ec44c633eb:/local/d-o-h:18636

Modified: trunk/owl/perlwrap.pm
===================================================================
--- trunk/owl/perlwrap.pm	2007-05-18 20:54:51 UTC (rev 713)
+++ trunk/owl/perlwrap.pm	2007-05-18 20:57:46 UTC (rev 714)
@@ -79,6 +79,35 @@
     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 {
     unshift @_, \&BarnOwl::new_variable_int_internal, 0;
     goto \&_new_variable;


home help back first fref pref prev next nref lref last post