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

Docs: doc updates

db4
Björn Lindqvist 2016-03-13 07:37:20 +01:00
parent df3f58ae61
commit db4c4665f3
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
basis/compiler/codegen/relocation/relocation-docs.factor
View File

@ -2,13 +2,9 @@ USING: alien byte-arrays byte-vectors compiler.constants cpu.architecture
help.markup help.syntax make vectors ;
IN: compiler.codegen.relocation
HELP: relocation-table
{ $description "A " { $link byte-vector } " holding the relocations for the current compilation. Each sequence of four bytes in the vector represents one relocation." }
{ $see-also init-relocation } ;
HELP: add-dlsym-parameters
{ $values { "symbol" byte-array } { "dll" dll } }
{ $description "Adds a pair of parameters for a reference to an external C function to the " { $link parameter-table } "." } ;
{ $description "Adds a pair of parameters for a reference to an external C function to the " { $link parameter-table } ". 'symbol' is the name of the function and 'dll' is the shared library which contains it." } ;
HELP: add-relocation
{ $values
@ -42,7 +38,12 @@ HELP: compiled-offset
} ;
HELP: parameter-table
{ $var-description "The parameter table is a " { $link vector } " which contains all the paramters for the word being generated." } ;
{ $var-description "The parameter table is a " { $link vector } " which contains all the parameters for the word being generated." }
{ $see-also add-dlsym-parameters init-relocation } ;
HELP: relocation-table
{ $description "A " { $link byte-vector } " holding the relocations for the current compilation. Each sequence of four bytes in the vector represents one relocation." }
{ $see-also init-relocation } ;
HELP: rel-decks-offset
{ $values { "class" "a relocation class" } }

9
core/alien/alien-docs.factor
View File

@ -1,6 +1,7 @@
USING: alien.accessors alien.c-types alien.libraries
USING: alien.accessors alien.c-types alien.libraries alien.strings
alien.syntax byte-arrays cpu.x86 eval help.markup help.syntax io
io.backend kernel math quotations sequences system ;
io.backend io.encodings.utf16n io.encodings.utf8 kernel math
quotations sequences system ;
IN: alien
HELP: callee-cleanup?
@ -41,7 +42,9 @@ HELP: alien
{ $class-description "The class of alien pointers. See " { $link "syntax-aliens" } " for syntax and " { $link "c-data" } " for general information." } ;
HELP: dll
{ $class-description "The class of native library handles. See " { $link "syntax-aliens" } " for syntax and " { $link "dll.private" } " for general information." } ;
{ $class-description "The class of native library handles. See " { $link "syntax-aliens" } " for syntax and " { $link "dll.private" } " for general information."
$nl
"The dll tuple has one slot 'path' which holds the filesystem path to the library being loaded in the systems " { $link native-string-encoding } ", usually " { $link utf8 } " on unices and " { $link utf16n } " on windows." } ;
HELP: dll-valid?
{ $values { "dll" dll } { "?" boolean } }