Changeset cd57601 for perlwrap.pm


Ignore:
Timestamp:
May 18, 2007, 4:57:46 PM (14 years ago)
Author:
Nelson Elhage <nelhage@mit.edu>
Branches:
master, barnowl_perlaim, debian, 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:
1 edited

Legend:

Unmodified
Added
Removed
  • perlwrap.pm

    ra695a68 rcd57601  
    7979    BarnOwl::new_command_internal($name, $func, $args{summary}, $args{usage}, $args{description});
    8080}
     81
     82=head2 new_variable_int NAME [{ARGS}]
     83
     84=head2 new_variable_bool NAME [{ARGS}]
     85
     86=head2 new_variable_string NAME [{ARGS}]
     87
     88Add a new owl variable, either an int, a bool, or a string, with the
     89specified name.
     90
     91ARGS can optionally contain the following keys:
     92
     93=over 4
     94
     95=item default
     96
     97The default and initial value for the variable
     98
     99=item summary
     100
     101A one-line summary of the variable's purpose
     102
     103=item description
     104
     105A longer description of the function of the variable
     106
     107=back
     108
     109=cut
    81110
    82111sub new_variable_int {
Note: See TracChangeset for help on using the changeset viewer.