[GT] SVN Commit r580 - trunk/GT

[GeniusTrader SVN <raphael AT geniustrader.org>]

Author: thomas
Date: 2008-03-20 20:24:56 +0100 (Thu, 20 Mar 2008)
New Revision: 580

Modified:
   trunk/GT/DB.pm
Log:
Add documentation.

Modified: trunk/GT/DB.pm
===================================================================
--- trunk/GT/DB.pm	2008-03-20 17:28:51 UTC (rev 579)
+++ trunk/GT/DB.pm	2008-03-20 19:24:56 UTC (rev 580)
@@ -33,6 +33,20 @@
     }
 }
 
+=over
+
+=item C<< get_name ($code) >>
+
+Returns the long name of the market (if defined). 
+
+See also ~/.gt/sharenames which contains lines of the form
+<code>\t<long name>
+mapping a market code to its long name.
+
+=back
+
+=cut
+
 sub get_name {
     my ($self, $code) = @_;