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

fix help lint failures

db4
Joe Groff 2009-09-01 13:04:00 -05:00
parent 26cc551049
commit 522f426ba7
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
basis/alien/c-types/c-types-docs.factor
View File

@ -49,7 +49,7 @@ HELP: c-setter
{ $errors "Throws an error if the type does not exist." } ;
HELP: <c-array>
{ $values { "n" "a non-negative integer" } { "type" "a C type" } { "array" byte-array } }
{ $values { "len" "a non-negative integer" } { "c-type" "a C type" } { "array" byte-array } }
{ $description "Creates a byte array large enough to hold " { $snippet "n" } " values of a C type." }
{ $notes "The appropriate specialized array vocabulary must be loaded; otherwise, a " { $link specialized-array-vocab-not-loaded } " error will be thrown. The vocabulary can be loaded with a " { $link POSTPONE: USING: } " form as usual, or with the " { $link require-c-arrays } " word. See the " { $vocab-link "specialized-arrays" } " vocabulary set for details on the underlying sequence type constructed." }
{ $errors "Throws an error if the type does not exist, the necessary specialized array vocabulary is not loaded, or the requested size is negative." } ;

2
basis/struct-arrays/struct-arrays-docs.factor
View File

@ -15,7 +15,7 @@ HELP: <direct-struct-array>
{ $description "Creates a new array for holding values of the specified C type, backed by the memory at " { $snippet "alien" } "." } ;
HELP: struct-array-on
{ $value { "struct" struct } { "length" integer } }
{ $values { "struct" struct } { "length" integer } { "struct-array" struct-array } }
{ $description "Create a new array for holding values of " { $snippet "struct" } "'s C type, backed by the memory starting at " { $snippet "struct" } "'s address." }
{ $examples
"This word is useful with the FFI. When a C function has a pointer to a struct as its return type (or a C callback has a struct pointer as an argument type), Factor automatically wraps the pointer in a " { $link struct } " object. If the pointer actually references an array of objects, this word will convert the struct object to a struct array object:"

4
extra/gpu/shaders/shaders-docs.factor
View File

@ -1,6 +1,6 @@
! (c)2009 Joe Groff bsd license
USING: classes classes.struct gpu.buffers help.markup help.syntax
images kernel math multiline quotations sequences strings ;
images kernel math multiline quotations sequences strings words ;
IN: gpu.shaders
HELP: <program-instance>
@ -86,7 +86,7 @@ HELP: define-vertex-format
HELP: define-vertex-struct
{ $values
{ "struct-name" string } { "vertex-format" vertex-format }
{ "class" word } { "vertex-format" vertex-format }
}
{ $description "Defines a new struct C type from a " { $link vertex-format } ". The runtime equivalent of " { $link POSTPONE: VERTEX-STRUCT: } ". This word must be called inside a compilation unit." } ;