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

Documentation updates

db4
Slava Pestov 2009-04-20 02:23:52 -05:00
parent 968bf4bcb4
commit ec72f33fcb
6 changed files with 15 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
basis/help/handbook/handbook.factor
View File

@ -249,6 +249,7 @@ ARTICLE: "handbook-language-reference" "The language"
{ $heading "Abstractions" }
{ $subsection "objects" }
{ $subsection "destructors" }
{ $subsection "parsing-words" }
{ $subsection "macros" }
{ $subsection "fry" }
{ $heading "Program organization" }

8
basis/ui/tools/profiler/profiler-docs.factor
View File

@ -1,10 +1,14 @@
IN: ui.tools.profiler
USING: help.markup help.syntax ui.operations help.tips ;
USING: help.markup help.syntax ui.operations ui.commands help.tips ;
ARTICLE: "ui.tools.profiler" "UI profiler tool"
"The " { $vocab-link "ui.tools.profiler" } " vocabulary implements a graphical tool for viewing profiling results (see " { $link "profiling" } ")."
$nl
"To use the profiler, enter a piece of code in the listener's input area and press " { $operation com-profile } "." ;
"To use the profiler, enter a piece of code in the listener input area and press " { $operation com-profile } "."
$nl
"Clicking on a vocabulary in the vocabulary list narrows down the word list to only include words from that vocabulary. The sorting options control the order of elements in the vocabulary and word lists. The search fields narrow down the list to only include words or vocabularies whose names contain a substring."
$nl
"Consult " { $link "profiling" } " for details about the profiler itself." ;
TIP: "Press " { $operation com-profile } " to run the code in the input field with profiling enabled (" { $link "ui.tools.profiler" } ")." ;

11
basis/ui/tools/tools-docs.factor
View File

@ -31,17 +31,6 @@ $nl
$nl
"For more about presentation gadgets, see " { $link "ui.gadgets.presentations" } "." ;
ARTICLE: "ui-profiler" "UI profiler"
"The graphical profiler is based on the terminal profiler (see " { $link "profiling" } ") and adds more convenient browsing of profiler results."
$nl
"To use the profiler, enter a piece of code in the listener input area and press " { $operation com-profile } "."
$nl
"Clicking on a vocabulary in the vocabulary list narrows down the word list to only include words from that vocabulary. The sorting options control the order of elements in the vocabulary and word lists. The search fields narrow down the list to only include words or vocabularies whose names contain a substring."
$nl
"Consult " { $link "profiling" } " for details about the profiler itself."
{ $command-map profiler-gadget "toolbar" }
"The profiler is an instance of " { $link profiler-gadget } "." ;
ARTICLE: "ui-cocoa" "Functionality specific to Mac OS X"
"On Mac OS X, the Factor UI offers additional features which integrate with this operating system."
$nl

6
core/combinators/combinators-docs.factor
View File

@ -303,13 +303,7 @@ ARTICLE: "combinators" "Combinators"
{ $subsection "combinators.short-circuit" }
{ $subsection "combinators.smart" }
"More combinators are defined for working on data structures, such as " { $link "sequences-combinators" } " and " { $link "assocs-combinators" } "."
$nl
"The " { $vocab-link "combinators" } " provides some less frequently-used features."
$nl
"A combinator which can help with implementing methods on " { $link hashcode* } ":"
{ $subsection recursive-hashcode }
{ $subsection "combinators-quot" }
"Advanced topics:"
{ $see-also "quotations" } ;
ABOUT: "combinators"

3
core/parser/parser-docs.factor
View File

@ -94,11 +94,10 @@ $nl
"This section concerns itself with usage and extension of the parser. Standard syntax is described in " { $link "syntax" } "."
{ $subsection "parser-files" }
"The parser can be extended."
{ $subsection "parsing-words" }
{ $subsection "parser-lexer" }
"The parser can be invoked reflectively;"
{ $subsection parse-stream }
{ $see-also "definitions" "definition-checking" } ;
{ $see-also "parsing-words" "definitions" "definition-checking" } ;
ABOUT: "parser"

6
core/quotations/quotations-docs.factor
View File

@ -25,6 +25,12 @@ ARTICLE: "wrappers" "Wrappers"
{ $subsection wrapper }
{ $subsection literalize }
"Wrapper literal syntax is documented in " { $link "syntax-words" } "."
{ $example
"IN: scratchpad"
"DEFER: my-word"
"\\ my-word name>> ."
"\"my-word\""
}
{ $see-also "combinators" } ;
ABOUT: "quotations"