Changeset 6458 for trunk/glueforge/glueforge.in

Timestamp:

Feb 21, 2006, 2:26:03 PM (20 years ago)

Author:

jhoblitt

Message:

spec 'descriptive' comments

File:

• trunk/glueforge/glueforge.in (modified) (5 diffs)

trunk/glueforge/glueforge.in

@@ -3 +3 @@
 # Copyright (C) 2005-2006  Joshua Hoblitt
 #
-# $Id: glueforge.in,v 1.46 2006-02-17 03:39:28 jhoblitt Exp $
+# $Id: glueforge.in,v 1.47 2006-02-22 00:26:03 jhoblitt Exp $
 
 use strict;
@@ -344 +344 @@
 
     table   STR     foo
-    foo     STR     60      # Primary Key
-    bar     S32     0
+    foo     STR     60      # Primary Key # the name of foo thing
+    bar     S32     0       ## count of bar
     baz     F32     0.0
     boing   F64     0.0
@@ -360 +360 @@
 C<F32>, C<F64>, & C<BOOL> columns are ignored.
 
-Keys maybe specified as a C<Primary Key> or C<Key>.  Only one C<Primary Key>
-may be specified per table.
+Indexes maybe specified as comment value of either C<Primary Key> or C<Key>.
+Only one C<Primary Key> may be specified per table.  
+
+Description comments may specified as either a C<# ...> after an index
+specifier or as stand alone comment value of C<## ...>.
 
 The key name C<position> is also reserved as it is used internally by the
@@ -387 +390 @@
 
 foo METADATA
-    foo     STR     60      # Primary Key
-    bar     S32     0 
+    foo     STR     60      # Primary Key # the name of foo thing
+    bar     S32     0       ## count of bar
     baz     F32     0.0
     boing   F64     0.0
@@ -398 +401 @@
     boing   F64     0.0
     baz     F32     0.0
-    bar     S32     0 
-    foo     STR     60      # Primary Key
+    bar     S32     0       ## count of bar
+    foo     STR     60      # Primary Key # the name of foo thing
 END