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

alien.(inline,marshall): removed unused doc helper words and made the rest private

db4
Jeremy Hughes 2009-07-14 22:32:08 +12:00
parent 010af379bb
commit 90b7ca501b
2 changed files with 10 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
basis/alien/inline/inline-docs.factor
View File

@ -3,10 +3,12 @@
USING: help.markup help.syntax kernel strings effects quotations ; USING: help.markup help.syntax kernel strings effects quotations ;
IN: alien.inline IN: alien.inline
<PRIVATE
: $binding-note ( x -- ) : $binding-note ( x -- )
drop drop
{ "This word requires that certain variables are correctly bound. " { "This word requires that certain variables are correctly bound. "
"Call " { $link POSTPONE: define-c-library } " to set them up." } print-element ; "Call " { $link POSTPONE: define-c-library } " to set them up." } print-element ;
PRIVATE>
HELP: ;C-LIBRARY HELP: ;C-LIBRARY
{ $syntax ";C-LIBRARY" } { $syntax ";C-LIBRARY" }

23
basis/alien/marshall/marshall-docs.factor
View File

@ -4,6 +4,7 @@ USING: help.markup help.syntax kernel quotations sequences
strings alien alien.c-types math byte-arrays ; strings alien alien.c-types math byte-arrays ;
IN: alien.marshall IN: alien.marshall
<PRIVATE
: $memory-note ( arg -- ) : $memory-note ( arg -- )
drop "This word returns a pointer to unmanaged memory." drop "This word returns a pointer to unmanaged memory."
print-element ; print-element ;
@ -15,19 +16,7 @@ IN: alien.marshall
: $see-article ( arg -- ) : $see-article ( arg -- )
drop { "See " { $vocab-link "alien.inline" } "." } drop { "See " { $vocab-link "alien.inline" } "." }
print-element ; print-element ;
PRIVATE>
: $marshall-descr* ( arg -- )
dup
"When the argument is a sequence, returns a pointer to an array of"
print-element print-element
"otherwise returns a pointer to a single "
print-element print-element " value." print-element ;
: $marshall-descr** ( arg -- )
"Takes a one or two dimensional array of "
print-element print-element
" and returns a pointer to the equivalent C structure."
print-element ;
HELP: ?malloc-byte-array HELP: ?malloc-byte-array
{ $values { $values
@ -62,7 +51,9 @@ HELP: marshall-bool*
{ "?/seq" "t/f or sequence" } { "?/seq" "t/f or sequence" }
{ "alien" alien } { "alien" alien }
} }
{ $description { $marshall-descr* "bool" } } { $description "When the argument is a sequence, returns a pointer to an array of bool, "
"otherwise returns a pointer to a single bool value."
}
{ $notes { $list $c-ptr-note $memory-note } } ; { $notes { $list $c-ptr-note $memory-note } } ;
HELP: marshall-bool** HELP: marshall-bool**
@ -70,7 +61,9 @@ HELP: marshall-bool**
{ "seq" sequence } { "seq" sequence }
{ "alien" alien } { "alien" alien }
} }
{ $description { $marshall-descr** "generalized booleans" } } { $description "Takes a one or two dimensional array of generalized booleans "
"and returns a pointer to the equivalent C structure."
}
{ $notes { $list $c-ptr-note $memory-note } } ; { $notes { $list $c-ptr-note $memory-note } } ;
HELP: marshall-primitive HELP: marshall-primitive