[svn:parrot] r40379 - branches/keys_cleanup/include/parrot

[bacek at svn.parrot.org]

Author: bacek
Date: Sun Aug  2 12:04:35 2009
New Revision: 40379
URL: https://trac.parrot.org/parrot/changeset/40379

Log:
[docs] Add little bit of description of KEY_flags.

It should save few hours for anyone else who will try to understand Keys mistery.

Modified:
   branches/keys_cleanup/include/parrot/key.h

Modified: branches/keys_cleanup/include/parrot/key.h
==============================================================================
--- branches/keys_cleanup/include/parrot/key.h	Sun Aug  2 11:53:32 2009	(r40378)
+++ branches/keys_cleanup/include/parrot/key.h	Sun Aug  2 12:04:35 2009	(r40379)
@@ -15,6 +15,14 @@
 
 #include "parrot/parrot.h"
 
+/*
+ Type of Keys.
+ C<KEY_register_FLAG> used for indirect referencing. E.g.
+   $S0 = "foo"
+   $P1 = $P0[$S0]
+ In this case C<[$S0]> will have type C<KEY_string_FLAG | KEY_register_FLAG>
+ and store I<integer> value of string register number.
+*/
 typedef enum {
     KEY_integer_FLAG        = PObj_private0_FLAG,
     KEY_number_FLAG         = PObj_private1_FLAG,