basis/struct-vectors/struct-vectors-docs.factor

   1 IN: struct-vectors
   2 USING: help.markup help.syntax classes.struct alien strings math ;
   3
   4 HELP: struct-vector
   5 { $class-description "The class of growable C struct and union arrays." } ;
   6
   7 HELP: <struct-vector>
   8 { $values { "capacity" integer } { "struct-class" struct-class } { "struct-vector" struct-vector } }
   9 { $description "Creates a new vector with the given initial capacity." } ;
  10
  11 ARTICLE: "struct-vectors" "C struct and union vectors"
  12 "The " { $vocab-link "struct-vectors" } " vocabulary implements vectors specialized for holding C struct and union values. These are growable versions of " { $vocab-link "struct-arrays" } "."
  13 { $subsection struct-vector }
  14 { $subsection <struct-vector> } ;
  15
  16 ABOUT: "struct-vectors"