]> gitweb.factorcode.org Git - factor.git/commitdiff
classes.struct: add some docs for read-struct.
authorJohn Benediktsson <mrjbq7@gmail.com>
Wed, 18 Apr 2012 23:02:00 +0000 (16:02 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Wed, 18 Apr 2012 23:02:00 +0000 (16:02 -0700)
basis/classes/struct/struct-docs.factor

index 02f7aee2ae57e1974e861b03e6d036b547c90f57..2457e86a1aa2282b26c331e44396cc19b944a214 100644 (file)
@@ -99,6 +99,10 @@ HELP: memory>struct
 }
 { $description "Constructs a new " { $link struct } " of the specified " { $snippet "class" } " at the memory location referenced by " { $snippet "ptr" } ". The referenced memory is unchanged." } ;
 
+HELP: read-struct
+{ $values { "class" class } { "struct" struct } }
+{ $description "Reads a new " { $link struct } " of the specified " { $snippet "class" } "." } ;
+
 HELP: struct
 { $class-description "The parent class of all struct types." } ;