Docs: doc updates

diff --git a/basis/compiler/codegen/relocation/relocation-docs.factor b/basis/compiler/codegen/relocation/relocation-docs.factor
index e4293c6368c6ece8c4cb5be6612c2659b88e7aa6..f6abdc85b5abe3f693e9a6ccfeb903c5a702f6a9 100644 (file)
--- a/basis/compiler/codegen/relocation/relocation-docs.factor
+++ b/basis/compiler/codegen/relocation/relocation-docs.factor
@@ -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" } }

diff --git a/core/alien/alien-docs.factor b/core/alien/alien-docs.factor
index e0b507509ce4c58559471c24569d5d85d16b0867..d7040710bb56336cd52b7f112931f31ebf5d01e5 100644 (file)
--- a/core/alien/alien-docs.factor
+++ b/core/alien/alien-docs.factor
@@ -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 } }