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

compiler.*: doc improvements

db4
Björn Lindqvist 2014-08-20 21:14:28 +02:00
parent 026aa163c8
commit 275082d603
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
basis/compiler/compiler-docs.factor
View File

@ -54,6 +54,8 @@ $nl
ABOUT: "compiler" ABOUT: "compiler"
HELP: compiled { $var-description "An " { $link assoc } " used during the compilation process which maps from words to their generated code." } ;
HELP: frontend HELP: frontend
{ $values { "word" word } { "tree" sequence } } { $values { "word" word } { "tree" sequence } }
{ $description "First step of the compilation process. It outputs a high-level tree in SSA form." } ; { $description "First step of the compilation process. It outputs a high-level tree in SSA form." } ;

9
core/compiler/units/units-docs.factor
View File

@ -91,6 +91,15 @@ $nl
$nl $nl
"If classes, methods or generic words were redefined, then inline cache call sites need to be updated as well. Passing " { $link t } " as the " { $snippet "reset-pics?" } " parameter enables this code path." "If classes, methods or generic words were redefined, then inline cache call sites need to be updated as well. Passing " { $link t } " as the " { $snippet "reset-pics?" } " parameter enables this code path."
} }
{ $examples
"Manually creating a word using the non-optimizing compiler:"
{ $example
"USING: compiler.units io ;"
"IN: test SYMBOL: foo"
"{ { foo [ \"hello!\" write nl ] } } t t modify-code-heap foo"
"hello!"
}
}
{ $notes "This word is called at the end of " { $link with-compilation-unit } "." } ; { $notes "This word is called at the end of " { $link with-compilation-unit } "." } ;
HELP: compile HELP: compile