]> gitweb.factorcode.org Git - factor.git/commitdiff
classes.c-types doc improvements
authorJoe Groff <joe@victoria.(none)>
Fri, 14 Aug 2009 11:29:28 +0000 (07:29 -0400)
committerJoe Groff <joe@victoria.(none)>
Fri, 14 Aug 2009 11:29:28 +0000 (07:29 -0400)
extra/classes/c-types/c-types-docs.factor

index 13363f99e88049c27045f74cab92cedf77111b98..f3d12585837ecece81eeba1e0bec7ef6ff24e78f 100644 (file)
@@ -13,13 +13,13 @@ HELP: direct-array-of
     { "alien" c-ptr } { "len" integer } { "class" c-type-class }
     { "array" "a direct array" }
 }
-{ $description "Constructs a direct array over " { $snippet "len" } " elements of type " { $snippet "class" } " located at the referenced location in memory." } ;
+{ $description "Constructs one of the " { $link "specialized-arrays.direct" } " over " { $snippet "len" } " elements of type " { $snippet "class" } " located at the referenced location in raw memory." } ;
 
 HELP: int
 { $class-description "A signed four-byte integer quantity." } ;
 
 HELP: long
-{ $class-description "A signed integer quantity. On 64-bit Unix platforms, this is an eight-byte quantity; on Windows and on 32-bit Unix platforms, it is four bytes." } ;
+{ $class-description "A signed integer quantity. On 64-bit Unix platforms, this is an eight-byte type; on Windows and on 32-bit Unix platforms, it is four bytes." } ;
 
 HELP: longlong
 { $class-description "A signed eight-byte integer quantity." } ;
@@ -40,7 +40,7 @@ HELP: uint
 { $class-description "An unsigned four-byte integer quantity." } ;
 
 HELP: ulong
-{ $class-description "An unsigned integer quantity. On 64-bit Unix platforms, this is an eight-byte quantity; on Windows and on 32-bit Unix platforms, it is four bytes." } ;
+{ $class-description "An unsigned integer quantity. On 64-bit Unix platforms, this is an eight-byte type; on Windows and on 32-bit Unix platforms, it is four bytes." } ;
 
 HELP: ulonglong
 { $class-description "An unsigned eight-byte integer quantity." } ;
@@ -64,6 +64,8 @@ ARTICLE: "classes.c-types" "C type classes"
 { $subsection float }
 { $subsection single-complex }
 { $subsection complex }
-{ $subsection pinned-c-ptr } ;
+{ $subsection pinned-c-ptr }
+"The vocabulary also provides a word for constructing " { $link "specialized-arrays.direct" } " of C types over raw memory:"
+{ $subsection direct-array-of } ;
 
 ABOUT: "classes.c-types"