From d536563ea560a987dbc48f3c5228da6bfa493b57 Mon Sep 17 00:00:00 2001 From: Elijah Perrault Date: Fri, 4 Feb 2011 18:41:06 -0700 Subject: [PATCH] Updated/fixed documentation and fixed formatting. --- modules/Bitly.pm | 10 +++++----- modules/Calc.pm | 20 ++++++-------------- modules/EightBall.pm | 8 +++++--- modules/FML.pm | 1 - modules/IsItUp.pm | 22 +++++++--------------- modules/SASLAuth.pm | 5 +++-- modules/Weather.pm | 25 +++++++++---------------- 7 files changed, 35 insertions(+), 56 deletions(-) diff --git a/modules/Bitly.pm b/modules/Bitly.pm index 86953c9..cf96e3c 100644 --- a/modules/Bitly.pm +++ b/modules/Bitly.pm @@ -37,10 +37,10 @@ sub _void # Help hashes. our %HELP_SHORTEN = ( - 'en' => "This command will shorten an URL using Bit.ly. Syntax: SHORTEN ", + 'en' => "This command will shorten an URL using Bit.ly. \002Syntax:\002 SHORTEN ", ); our %HELP_REVERSE = ( - 'en' => "This command will expand a Bit.ly URL. Syntax: REVERSE ", + 'en' => "This command will expand a Bit.ly URL. \002Syntax:\002 REVERSE ", ); # Callback for SHORTEN command. @@ -173,9 +173,9 @@ Add Bitly to module auto-load and the following to your configuration file: =over -This module adds an extra dependency: LWP::UserAgent. You can get it from -the CPAN . +This module adds an extra dependency: LWP::UserAgent. You can get it +from the CPAN . -This module is compatible with Auto version 3.0a2+. +This module is compatible with Auto version 3.0.0a2+. =back diff --git a/modules/Calc.pm b/modules/Calc.pm index 957136f..7872a57 100644 --- a/modules/Calc.pm +++ b/modules/Calc.pm @@ -30,9 +30,9 @@ sub _void return 1; } -# Help hashes. +# Help hash. our %FHELP_CALC = ( - 'en' => "This command will calculate an expression using Google Calculator. Syntax: CALC ", + 'en' => "This command will calculate an expression using Google Calculator. \002Syntax:\002 CALC ", ); # Callback for CALC command. @@ -94,14 +94,6 @@ Google Calculator. =back -=head2 How To Use - -=over - -Add Calc to the module autoload. - -=back - =head2 Examples =over @@ -115,7 +107,7 @@ Add Calc to the module autoload. =over -* Add Spanish, French and German translations for the help hashes. +* Add Spanish, French and German translations for the help hash. =back @@ -123,9 +115,9 @@ Add Calc to the module autoload. =over -This module requires LWP::UserAgent, URI::Escape and JSON. All are obtainable -from the CPAN . +This module requires LWP::UserAgent, URI::Escape and JSON. All are +obtainable from the CPAN . -This module is compatible with Auto version 3.0a2+. +This module is compatible with Auto version 3.0.0a2+. =back diff --git a/modules/EightBall.pm b/modules/EightBall.pm index 3eb7df3..c45e11e 100644 --- a/modules/EightBall.pm +++ b/modules/EightBall.pm @@ -33,10 +33,10 @@ sub _void # Help hashes. our %HELP_8BALL = ( - 'en' => "This command will ask the magic 8-Ball your question. Syntax: 8BALL ", + 'en' => "This command will ask the magic 8-Ball your question. \002Syntax:\002 8BALL ", ); our %HELP_RIGBALL = ( - 'en' => "This command will \"rig\" (set) the answer of the next 8-Ball question. Syntax: RIGBALL ", + 'en' => "This command will \"rig\" (set) the answer of the next 8-Ball question. \002Syntax:\002 RIGBALL ", ); # Callback for 8BALL command. @@ -143,6 +143,8 @@ command for setting ("rigging") the 8-Ball's next answer. =over -This module is compatible with Auto version 3.0a2+. +This module is compatible with Auto version 3.0.0a2+. + +Ported from Auto 1.0. =back diff --git a/modules/FML.pm b/modules/FML.pm index d08de53..bda7c7c 100644 --- a/modules/FML.pm +++ b/modules/FML.pm @@ -66,7 +66,6 @@ sub fml return 1; } - # Start initialization. API::Std::mod_init("FML", "Xelhua", "1.00", "3.0.0d", __PACKAGE__); diff --git a/modules/IsItUp.pm b/modules/IsItUp.pm index 77e8a79..8d30e2e 100644 --- a/modules/IsItUp.pm +++ b/modules/IsItUp.pm @@ -30,8 +30,8 @@ sub _void # Help hashes. our %HELP_ISITUP = ( - 'en' => "This command will check if a website appears up or down to the bot. Syntax: ISITUP ", - ); + 'en' => "This command will check if a website appears up or down to the bot. \002Syntax:\002 ISITUP ", +); # Callback for ISITUP command. sub check @@ -80,16 +80,8 @@ __END__ =over -This module adds the ISITUP command for checking if a -website appears up or down to Auto. - -=back - -=head2 How To Use - -=over - -Add IsItUp to the module autoload. +This module adds the ISITUP command for checking if a website +appears up or down to Auto. =back @@ -114,9 +106,9 @@ Add IsItUp to the module autoload. =over -This module requires LWP::UserAgent. All are obtainable -from the CPAN . +This module requires LWP::UserAgent. You can get it from +the CPAN . -This module is compatible with Auto version 3.0a2+. +This module is compatible with Auto version 3.0.0a2+. =back diff --git a/modules/SASLAuth.pm b/modules/SASLAuth.pm index 5030b6e..3472881 100644 --- a/modules/SASLAuth.pm +++ b/modules/SASLAuth.pm @@ -183,8 +183,9 @@ block(s) you wish to use SASL with: =over -This adds an extra dependency: You must build Auto with the --enable-sasl option. +This adds an extra dependency: You must build Auto with the +--enable-sasl option. -This module is compatible with Auto v3.0a1+. +This module is compatible with Auto v3.0.0a1+. =back diff --git a/modules/Weather.pm b/modules/Weather.pm index 637866c..bfff816 100644 --- a/modules/Weather.pm +++ b/modules/Weather.pm @@ -31,8 +31,8 @@ sub _void # Help hashes. our %HELP_WEATHER = ( - 'en' => "This command will retrieve the weather via Wunderground for the specified location. Syntax: WEATHER ", - ); + 'en' => "This command will retrieve the weather via Wunderground for the specified location. \002Syntax:\002 WEATHER ", +); # Callback for Weather command. sub weather @@ -89,16 +89,8 @@ __END__ =over -This module adds the WEATHER command for retrieving -the current weather. - -=back - -=head2 How To Use - -=over - -Add Weather to the module autoload. +This module adds the WEATHER command for retrieving the +current weather. =back @@ -107,7 +99,8 @@ Add Weather to the module autoload. =over !weather 10111 - Results for Central Park, New York - Temperature: 27 F (-3 C) Wind Conditions: From the NE at 9 MPH Gusting to 22 MPH Conditions: Overcast + Results for Central Park, New York - Temperature: 27 F (-3 C) Wind Conditions: +From the NE at 9 MPH Gusting to 22 MPH Conditions: Overcast Heat index: NA Humidity: 89% Pressure: 30.22 in (1023 mb) - Last Updated on February 1, 9:51 PM EST =back @@ -124,9 +117,9 @@ Add Weather to the module autoload. =over -This module requires LWP::UserAgent and XML::Simple. Both obtainable -from CPAN . +This module requires LWP::UserAgent and XML::Simple. Both are +obtainable from CPAN . -This module is compatible with Auto version 3.0a2+. +This module is compatible with Auto version 3.0.0a2+. =back