aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Guldstrand <andreas.guldstrand@gmail.com>2016-12-08 14:53:24 +0200
committerAndreas Guldstrand <andreas.guldstrand@gmail.com>2016-12-08 14:53:24 +0200
commit5d9f4c56b71cca245c23ba3ea7ee5cede06ba963 (patch)
tree879350dcbb77822ab8d531715f4332beb9d4473b
parent788f5da5669a31323ba07c0701a30aeaa29e852f (diff)
downloadsbotools-5d9f4c56b71cca245c23ba3ea7ee5cede06ba963.tar.xz
SBO::Lib::Info: document parse_info. This closes #46.
-rw-r--r--SBO-Lib/lib/SBO/Lib/Info.pm9
1 files changed, 9 insertions, 0 deletions
diff --git a/SBO-Lib/lib/SBO/Lib/Info.pm b/SBO-Lib/lib/SBO/Lib/Info.pm
index 36458ad..c000c4e 100644
--- a/SBO-Lib/lib/SBO/Lib/Info.pm
+++ b/SBO-Lib/lib/SBO/Lib/Info.pm
@@ -201,6 +201,15 @@ sub get_sbo_version {
return $version->[0];
}
+=head2 parse_info
+
+ my %parse = parse_info($str);
+
+C<parse_info()> parses the contents of an .info file from C<$str> and returns
+a key-value list of it.
+
+=cut
+
sub parse_info {
script_error('parse_info requires an argument.') unless @_ == 1;
my $info_str = shift;