]> gitweb.factorcode.org Git - factor.git/commitdiff
alien: fix docs (add space between sentences).
authorJohn Benediktsson <mrjbq7@gmail.com>
Thu, 22 Sep 2011 02:33:23 +0000 (19:33 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Thu, 22 Sep 2011 02:33:23 +0000 (19:33 -0700)
basis/alien/c-types/c-types-docs.factor
basis/alien/syntax/syntax-docs.factor

index dc1754a1497a6cd3e08982b53ed52d7f80948368..3d3dc1797860d16b850e7017e0ed8b486dbbd659 100644 (file)
@@ -86,7 +86,7 @@ HELP: pointer:
 { $description "Constructs a " { $link pointer } " C type." } ;
 
 HELP: pointer
-{ $class-description "Represents a pointer C type. The " { $snippet "to" } " slot contains the C type being pointed to." { $link byte-array } " and " { $link alien } " values can be provided as pointer function inputs, but see " { $link "byte-arrays-gc" } " for notes about passing byte arrays into C functions. Objects with methods on " { $link >c-ptr } ", such as structs and specialized arrays, may also be used as pointer inputs."
+{ $class-description "Represents a pointer C type. The " { $snippet "to" } " slot contains the C type being pointed to. Both " { $link byte-array } " and " { $link alien } " values can be provided as pointer function inputs, but see " { $link "byte-arrays-gc" } " for notes about passing byte arrays into C functions. Objects with methods on " { $link >c-ptr } ", such as structs and specialized arrays, may also be used as pointer inputs."
 $nl
 "Pointer output values are represented in Factor as " { $link alien } "s. If the pointed-to type is a struct, the alien will automatically be wrapped in a struct object if it is not null."
 $nl
index 4901651ce3c4b5ad7c503defe274522b6993652c..514d1c7fafc38e984752fec2fb24eec28453fed1 100644 (file)
@@ -83,7 +83,7 @@ HELP: ENUM:
 HELP: C-TYPE:
 { $syntax "C-TYPE: type" }
 { $values { "type" "a new C type" } }
-{ $description "Defines a new, opaque C type. Since it is opaque, " { $snippet "type" } " will not be directly usable as a parameter or return type of a " { $link POSTPONE: FUNCTION: } " or as a slot of a " { $link POSTPONE: STRUCT: } ". However, it can be used as the type of a " { $link pointer } "."
+{ $description "Defines a new, opaque C type. Since it is opaque, " { $snippet "type" } " will not be directly usable as a parameter or return type of a " { $link POSTPONE: FUNCTION: } " or as a slot of a " { $link POSTPONE: STRUCT: } ". However, it can be used as the type of a " { $link pointer } "." $nl
 { $snippet "C-TYPE:" } " can also be used to forward declare C types, allowing circular dependencies to occur between types. For example:"
 { $code """C-TYPE: forward 
 STRUCT: backward { x forward* } ;