diff options
author | Tzafrir Cohen <tzafrir@cohens.org.il> | 2009-05-25 02:25:51 +0300 |
---|---|---|
committer | Tzafrir Cohen <tzafrir@cohens.org.il> | 2009-05-25 02:25:51 +0300 |
commit | 7ee10adf5f728ff7b56735fb33f89052eabd8b84 (patch) | |
tree | 9019e495b5d739bddb7d44c09e1258fb6095c537 | |
parent | e73392763c011dade12dde89a5b723138794cc55 (diff) |
A few more minor documentation updates
-rwxr-xr-x | lib/Asterisk/config.pm | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/lib/Asterisk/config.pm b/lib/Asterisk/config.pm index 14a386b..1c88311 100755 --- a/lib/Asterisk/config.pm +++ b/lib/Asterisk/config.pm @@ -735,14 +735,14 @@ of lists (list of lines). $sip_conf->fetch_keys_list(section=>[section name|unsection]); -return keys list of section name or unsection. +Returns list of the kes in the keys in I<section name> (or +I<unsection>). =head2 fetch_keys_hashref $sip_conf->fetch_keys_hashref(section=>[section name|unsection]); -return referenced key list (and keys value), section value 'unsection' -return all unsection keys, if section name unreachable return failed. +Returns the section as a hash of key=>value pairs. =head2 fetch_values_arrayref @@ -756,8 +756,9 @@ failed. if key name unreachable return failed. $sip_conf->reload(); -reload and parse config file. -if clean_when_reload true will do clean_assign. +Reloads and parses the config file. + +If L<clean_when_reload> is true, will also do L<clean_assign>. =head1 OBJECT WRITE METHOD @@ -765,13 +766,13 @@ if clean_when_reload true will do clean_assign. $sip_conf->set_objvar('var_name'=>'value'); -set the object variables to new value. +Set the object variables to new value. =head2 assign_cleanfile $sip_conf->assign_cleanfile(); -assign clean all to file. +Resets all the non-saved changes (from other assign_* functions). =head2 assign_matchreplace |