steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

classes.struct: add some docs for read-struct.

db4
John Benediktsson 2012-04-18 16:02:00 -07:00
parent 4c416bc308
commit e3e6e12c6a
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
basis/classes/struct/struct-docs.factor
View 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." } ;