suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix some easy stuff missing in the browser docs

Browse Source
This commit is contained in:
Robby Findler 2011-04-26 23:23:28 -05:00
parent 06ed2045ae
commit 052b257e44
2 changed files with 42 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
collects/browser/browser.scrbl
View File

@ -32,7 +32,8 @@ launching an external browser (such as Firefox).
@section[#:tag "browser"]{Browser}
@defmodule[browser]
@defmodule*/no-declare[(browser)]
@declare-exporting[browser/browser browser]
The browser supports basic HTML commands, plus special Racket hyperlinks
of the form @litchar{<A MZSCHEME=sexpr>...</A>}. When the user clicks
@ -99,12 +100,7 @@ The @litchar{MZSCHEME} forms are disabled unless the web page is a
@; ----------------------------------------------------------------------
@defmixin[hyper-frame-mixin (frame%) ()]{
@defconstructor/auto-super[([url (or/c url? string? input-port?)])]{
Shows the frame and visits @racket[url].
}
@definterface[hyper-frame<%> ()]{
@defmethod[(get-hyper-panel%) (subclass?/c panel%)]{
Returns the class that is instantiated when the frame is created.
Must be a panel with hyper-panel-mixin mixed in. Defaults to just
@ -118,6 +114,16 @@ The @litchar{MZSCHEME} forms are disabled unless the web page is a
@; ----------------------------------------------------------------------
@defmixin[hyper-frame-mixin (frame%) (hyper-frame<%>)]{
@defconstructor/auto-super[([url (or/c url? string? input-port?)])]{
Shows the frame and visits @racket[url].
}
}
@; ----------------------------------------------------------------------
@defclass[hyper-no-show-frame%
(hyper-frame-mixin (frame:status-line-mixin frame:basic%))
()]
@ -137,7 +143,15 @@ The @litchar{MZSCHEME} forms are disabled unless the web page is a
@; ----------------------------------------------------------------------
@defmixin[hyper-text-mixin (text%) ()]{
@definterface[hyper-text<%> ()]{
@defmethod[(url-allows-evalling? [url (or/c port? url?)]) boolean?]{
Determines if @litchar{MZSCHEME} annotations are actually evaluated,
for a given url.
}
}
@; ----------------------------------------------------------------------
@defmixin[hyper-text-mixin (text%) (hyper-text<%>)]{
An instance of a @racket[hyper-text-mixin]-extended class should be
displayed only in an instance of a class created with
@ -257,6 +271,9 @@ The @litchar{MZSCHEME} forms are disabled unless the web page is a
}
@defclass[hyper-canvas% (hyper-canvas-mixin canvas:basic%) ()]{}
@; ----------------------------------------------------------------------
@defclass[hyper-text% (hyper-text-mixin text:keymap%) ()]{
@ -328,7 +345,12 @@ The @litchar{MZSCHEME} forms are disabled unless the web page is a
@; ----------------------------------------------------------------------
@defmixin[hyper-panel-mixin (area-container<%>) ()]{
@definterface[hyper-panel<%> ()]{
}
@; ----------------------------------------------------------------------
@defmixin[hyper-panel-mixin (area-container<%>) (hyper-panel<%>)]{
@defconstructor/auto-super[([info-line? any/c])]{
Creates controls and a hyper text canvas. The controls permit a
@ -442,6 +464,16 @@ The @litchar{MZSCHEME} forms are disabled unless the web page is a
}
}
@defstruct[(exn:cancelled exn) ()]{
This exception may be raised by the
@method[hyper-text-mixin reload] method.
}
@defstruct[(exn:file-saved-instead exn) ([pathname path-string?])]{
This exception may be raised by the
@method[hyper-text-mixin reload] method.
}
@; ----------------------------------------------------------------------
@section[#:tag "browser-unit"]{Browser Unit}

2
collects/browser/tests/test-docs-complete.rkt
View File

@ -3,7 +3,7 @@
(check-docs (quote browser))
(check-docs (quote browser/htmltext))
(check-docs (quote browser/external))
(check-docs (quote browser/bullet-snip))
(check-docs (quote browser/bullet-snip) #:skip '(snip-class))
(check-docs (quote browser/browser))
(check-docs (quote browser/browser-unit))
(check-docs (quote browser/browser-sig))