unmaintained/alien/marshall/structs/structs-docs.factor

   1 ! Copyright (C) 2009 Jeremy Hughes.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: classes help.markup help.syntax kernel quotations words
   4 alien.marshall.structs strings alien.structs alien.marshall ;
   5 IN: alien.marshall.structs
   6
   7 HELP: define-marshalled-struct
   8 { $values
   9     { "name" string } { "vocab" "a vocabulary specifier" } { "fields" "an alist" }
  10 }
  11 { $description "Calls " { $link define-struct } " and " { $link define-struct-tuple } "." } ;
  12
  13 HELP: define-struct-tuple
  14 { $values
  15     { "name" string }
  16 }
  17 { $description "Defines a subclass of " { $link struct-wrapper } ", a constructor, "
  18   "and accessor words."
  19 } ;