From 522f426ba7a8103520bbc0ddb350c18ac16ccb79 Mon Sep 17 00:00:00 2001 From: Joe Groff Date: Tue, 1 Sep 2009 13:04:00 -0500 Subject: [PATCH] fix help lint failures --- basis/alien/c-types/c-types-docs.factor | 2 +- basis/struct-arrays/struct-arrays-docs.factor | 2 +- extra/gpu/shaders/shaders-docs.factor | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/basis/alien/c-types/c-types-docs.factor b/basis/alien/c-types/c-types-docs.factor index b6b28d0a95..ac9a959d4c 100644 --- a/basis/alien/c-types/c-types-docs.factor +++ b/basis/alien/c-types/c-types-docs.factor @@ -49,7 +49,7 @@ HELP: c-setter { $errors "Throws an error if the type does not exist." } ; HELP: -{ $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." } ; diff --git a/basis/struct-arrays/struct-arrays-docs.factor b/basis/struct-arrays/struct-arrays-docs.factor index 7b49d6ef42..3e7582f8cd 100644 --- a/basis/struct-arrays/struct-arrays-docs.factor +++ b/basis/struct-arrays/struct-arrays-docs.factor @@ -15,7 +15,7 @@ HELP: { $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:" diff --git a/extra/gpu/shaders/shaders-docs.factor b/extra/gpu/shaders/shaders-docs.factor index 8ccc65da43..3ffe8e96bb 100755 --- a/extra/gpu/shaders/shaders-docs.factor +++ b/extra/gpu/shaders/shaders-docs.factor @@ -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: @@ -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." } ;