annotate docs/modules/txt/PackageInfo.txt @ 0:4816e4a8ae95 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 PackageInfo
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 use PackageInfo;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 use PackageInfo qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 PackageInfo module provides the following functions:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 GetPackageKeyValue, IsPackageKeyNameAvailable, SetPackageKeyValue
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 The functions to set and get package keyvalues not explicitly defined in
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 this module are implemented using Perl's AUTOLOAD functionality. These
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 methods are generated on-the-fly for a specified key:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 Set<KeyName>(<KeyValue>);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 $KeyValue = Get<KeyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 PackageInfo module provides functionality to retrieve information about
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 MayaChemTools package from PackagaInfo.csv which contains the following
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 types key name and values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 "KeyName","KeyValue"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 "PackageName","MayaChemTools"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 "ReleaseDate","Oct 21, 2010"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 "VersionNumber","7.4"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 "DevSoftwareEnvironment","Cygwin on Windows XP"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 ... ...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 ... ...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 FUNCTIONS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 GetPackageKeyValue
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 $KeyValue = GetPackageKeyValue($KeyName);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 Returns KeyValue for a specified *KeyName*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 IsPackageKeyNameAvailable
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 $Status = IsPackageKeyNameAvailable($KeyName);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 Returns 1 or 0 based on whether *KeyName* is available in package
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 info file.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 SetPackageKeyValue
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 SetPackageKeyValue($KeyName, $KeyValue);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 Sets *KeyValue* for a *KeyName*. No data is written to package info
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 file.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63