]> gitweb.factorcode.org Git - factor.git/commitdiff
Add docs for break and B words
authorSlava Pestov <slava@shill.local>
Sat, 22 Aug 2009 22:45:18 +0000 (17:45 -0500)
committerSlava Pestov <slava@shill.local>
Sat, 22 Aug 2009 22:45:18 +0000 (17:45 -0500)
basis/tools/continuations/continuations-docs.factor [new file with mode: 0644]
basis/tools/walker/walker-docs.factor [new file with mode: 0644]
basis/ui/tools/walker/walker-docs.factor

diff --git a/basis/tools/continuations/continuations-docs.factor b/basis/tools/continuations/continuations-docs.factor
new file mode 100644 (file)
index 0000000..bd69fb4
--- /dev/null
@@ -0,0 +1,6 @@
+IN: tools.continuations
+USING: help.markup help.syntax ;
+
+HELP: break
+{ $description "A breakpoint. When this word is executed, the walker tool opens with execution suspended at the breakpoint's location." }
+{ $see-also "ui-walker" } ;
\ No newline at end of file
diff --git a/basis/tools/walker/walker-docs.factor b/basis/tools/walker/walker-docs.factor
new file mode 100644 (file)
index 0000000..b636760
--- /dev/null
@@ -0,0 +1,5 @@
+IN: tools.walker
+USING: help.syntax help.markup tools.continuations ;
+
+HELP: B
+{ $description "An alias for " { $link break } ", defined in the " { $vocab-link "syntax" } " vocabulary so that it is always available." } ;
\ No newline at end of file
index 9e73a312825506113c79a671d7de473dc2f0ea51..ce354da2689034206066fdc506420d56d35d11d9 100644 (file)
@@ -28,6 +28,7 @@ ARTICLE: "breakpoints" "Setting breakpoints"
 $nl\r
 "Breakpoints can be inserted directly into code:"\r
 { $subsection break }\r
+{ $subsection POSTPONE: B }\r
 "Note that because the walker calls various core library and UI words while rendering its own user interface, setting a breakpoint on a word such as " { $link append } " or " { $link draw-gadget } " will hang the UI." ;\r
 \r
 ARTICLE: "ui-walker" "UI walker"\r