fixed some bugs in the docs

svn: r9938
This commit is contained in:
Robby Findler 2008-05-23 00:16:02 +00:00
parent e22b4c47e3
commit 90fbc2e14b
5 changed files with 28 additions and 29 deletions

View File

@ -18,12 +18,14 @@
scheme/contract
scheme/base
drscheme/tool-lib
mrlib/switchable-button
framework))
(provide (for-label (all-from-out scheme/gui/base)
(all-from-out scheme/class)
(all-from-out scheme/contract)
(all-from-out scheme/base)
(all-from-out drscheme/tool-lib)
(all-from-out mrlib/switchable-button)
(all-from-out framework)))
(provide docs-get/extend)

View File

@ -9,7 +9,7 @@ side of drscheme's frame.
@defconstructor/make[([parent (instance (implements @scheme[area-container<%>]))])]{}
@defconstructor/make[([parent (is-a?/c area-container<%>)])]{}
@defmethod[(set-message [name (or/c string? false/c)]
[short-name string?])
@ -85,8 +85,8 @@ adds a
}
@defmethod[#:mode override
(file-menu:new-callback [item (instance (derived-from @scheme[menu-item%]))]
[evt (instance @scheme[control-event%])])
(file-menu:new-callback [item (is-a?/c menu-item%)]
[evt (is-a?/c control-event%)])
void?]{
Opens a new, empty DrScheme window.
@ -104,8 +104,8 @@ Returns the empty string.
}
@defmethod[#:mode override
(file-menu:open-callback [item (instance (derived-from @scheme[menu-item%]))]
[evt (instance @scheme[control-event%])])
(file-menu:open-callback [item (is-a?/c menu-item%)]
[evt (is-a?/c control-event%)])
void?]{
Calls
@ -142,8 +142,8 @@ Defaultly returns the empty list.
}}
@defmethod[#:mode override
(help-menu:about-callback [item (instance (derived-from @scheme[menu-item%]))]
[evt (instance @scheme[control-event%])])
(help-menu:about-callback [item (is-a?/c menu-item%)]
[evt (is-a?/c control-event%)])
void?]{
Opens an about box for DrScheme.
@ -161,13 +161,10 @@ Returns the string @scheme["DrScheme"].
}
@defmethod[#:mode override
(help-menu:before-about [help-menu (instance @scheme[menu%])])
(help-menu:before-about [help-menu (is-a?/c menu%)])
void?]{
Adds the Help Desk menu item and the Welcome to DrScheme menu item.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% betweens
}
@defmethod[#:mode override
@ -213,7 +210,7 @@ Does nothing.
}}
@defmethod[(get-show-menu)
(instanceof @scheme[menu%])]{
(is-a?/c menu%)]{
\index{View menu}
returns the view menu, for use by the

View File

@ -331,7 +331,7 @@ Use the
@defmethod[(config-panel [parent (instanceof @scheme[panel%])])
@defmethod[(config-panel [parent (is-a?/c panel%)])
(case-> (-> settings) (settings -> void))]{
This method is the same as
@method[drscheme:language:language<%> config-panel].
@ -588,7 +588,7 @@ Defaultly returns the value from:
}}
@defmethod[(config-panel [parent (instanceof @scheme[panel%])])
@defmethod[(config-panel [parent (is-a?/c panel%)])
(case-> (-> settings) (settings -> void))]{
This method used by the language configuration dialog to
construct the "details" panel for this language. It accepts

View File

@ -321,7 +321,7 @@ editor it is mixed onto.
@defmethod[#:mode override
(get-keymaps)
(listof (instanceof @scheme[keymap%]))]{
(listof (is-a?/c keymap%))]{
Calls the super method and adds in a keymap with the
drscheme-specific keybindings:

View File

@ -346,26 +346,26 @@ Returns @scheme["Definitions"].
}
@defmethod[(get-break-button)
(instanceof @scheme[button%])]{
(is-a?/c button%)]{
Returns the break button. Mostly used for test suites.
}
@defmethod[(get-button-panel)
(instanceof @scheme[horizontal-panel%])]{
(is-a?/c horizontal-panel%)]{
This panel goes along the top of the drscheme window and has buttons
for important actions the user frequently executes.
A tool can add a button to this panel to make some new functionality
easily accessible to the user.
See also mrlib's @scheme[bitmap-label-maker].
See also mrlib's @scheme[switchable-button%].
}
@defmethod[#:mode override
(get-canvas)
(instanceof @scheme[editor-canvas%])]{
(is-a?/c editor-canvas%)]{
Returns the result of
@method[drscheme:unit:frame<%> get-definitions-canvas].
@ -375,7 +375,7 @@ Returns the result of
@defmethod[#:mode override
(get-canvas\%)
(instanceof (derived-from @scheme[canvas%]))]{
(is-a?/c canvas%)]{
Returns the result of
@scheme[drscheme:get/extend:get-definitions-canvas].
@ -384,7 +384,7 @@ Returns the result of
}
@defmethod*[([(get-definitions/interactions-panel-parent)
(instanceof @scheme[vertical-panel%])]
(is-a?/c vertical-panel%)]
[(get-definitions/interactions-panel-parent)
void?])]{
@methspec{
@ -413,7 +413,7 @@ Second case:
@defmethod[#:mode override
(get-editor)
(instanceof @scheme[editor<%>])]{
(is-a?/c editor<%>)]{
Returns the result of
@method[drscheme:unit:frame<%> get-definitions-text].
@ -424,7 +424,7 @@ Returns the result of
@defmethod[#:mode override
(get-editor\%)
(instanceof (derived-from @scheme[editor<%>]))]{
(is-a?/c editor<%>)]{
Returns the result of
@scheme[drscheme:get/extend:get-definitions-text].
@ -433,7 +433,7 @@ Returns the result of
}
@defmethod[(get-execute-button)
(instanceof @scheme[button%])]{
(is-a?/c button%)]{
Returns the Run button. Mostly used for test suites.
}
@ -576,7 +576,7 @@ Returns the currently active tab.
}
@defmethod[(get-definitions-canvas)
(instanceof (derivedfrom @scheme[drscheme:unit:definitions-canvas%]))]{
(is-a?/c drscheme:unit:definitions-canvas%)]{
This canvas is the canvas containing the
@method[drscheme:unit:frame<%> get-definitions-text]. It is initially the top half of the drscheme window.
@ -589,7 +589,7 @@ object, but if you change the
}
@defmethod[(get-definitions-text)
(instaceof (derivedfrom @scheme[drscheme:unit:definitions-text%]))]{
(is-a?/c drscheme:unit:definitions-text%)]{
Calls result of
@method[drscheme:unit:frame<%> get-current-tab]'s
@ -599,7 +599,7 @@ Calls result of
}
@defmethod[(get-insert-menu)
(is-a?/c @scheme[menu%])]{
(is-a?/c menu%)]{
@methspec{
Returns the \scm|"Insert"| menu.
@ -637,8 +637,8 @@ Returns the list of tabs in this frame.
}
@defmethod[#:mode pubment
(on-tab-change [from-tab (is-a?/c @scheme[drscheme:unit:tab<%>])]
[to-tab (is-a?/c @scheme[drscheme:unit:tab<%>])])
(on-tab-change [from-tab (is-a?/c drscheme:unit:tab<%>)]
[to-tab (is-a?/c drscheme:unit:tab<%>)])
void?]{
@methspec{