properly indent documentation

svn: r15056
This commit is contained in:
Eli Barzilay 2009-06-02 17:26:15 +00:00
parent 7d7f825a9e
commit 03f50e117f

View File

@ -324,8 +324,8 @@
(lambda (str)
((string-length str) . <= . 200)))])
@{Formats a string whose ampersand characters are
escaped; the label is also trimmed to <= 200
characters.})
mk-escaped; the label is also trimmed to <= 200
mk-characters.})
(proc-doc/names
gui-utils:cancel-on-right?
@ -353,8 +353,8 @@
(cancel-label (string-constant cancel))))
@{Adds an Ok and a cancel button to a panel, changing the order
to suit the platform. Under Mac OS X and unix, the confirmation action
is on the right (or bottom) and under Windows, the canceling action is on the
right (or bottom).
is on the right (or bottom) and under Windows, the canceling action is on
the right (or bottom).
The confirmation action button has the @scheme['(border)] style.
The buttons are also sized to be the same width.
@ -415,8 +415,7 @@
to appear after 2 seconds and the action may or may not take more than
two seconds, use this pattern:
@schemeblock[
(let ([close-down
@schemeblock[(let ([close-down
(gui-utils:delay-action
2
(λ () .. init watch cursor ...)
@ -440,10 +439,9 @@
((window thunk)
((delay (gui-utils:cursor-delay))))
@{Evaluates @scheme[(thunk)] with a watch cursor in @scheme[window]. If
@scheme[window] is @scheme[#f], the watch cursor is turned on globally. The
argument @scheme[delay] specifies the amount of time before the watch
cursor is opened. Use
@scheme[gui-utils:cursor-delay]
@scheme[window] is @scheme[#f], the watch cursor is turned on globally.
The argument @scheme[delay] specifies the amount of time before the watch
cursor is opened. Use @scheme[gui-utils:cursor-delay]
to set this value for all uses of this function.
The result of this function is the result of @scheme[thunk].})
@ -502,9 +500,10 @@
(checkbox-proc #f)
(checkbox-label (string-constant dont-ask-again))))
@{Opens a dialog that presents a binary choice to the user. The user is forced
to choose between these two options, ie cancelling or closing the dialog
opens a message box asking the user to actually choose one of the two options.
@{Opens a dialog that presents a binary choice to the user. The user is
forced to choose between these two options, ie cancelling or closing the
dialog opens a message box asking the user to actually choose one of the
two options.
The dialog will contain the string @scheme[message] and two buttons,
labeled with the @scheme[true-choice] and the @scheme[false-choice]. If the
@ -516,8 +515,7 @@
is not allowed. If it is anything else, that value is returned when
the user closes the window.
If
@scheme[gui-utils:cancel-on-right?]
If @scheme[gui-utils:cancel-on-right?]
returns @scheme[#t], the false choice is on the right.
Otherwise, the true choice is on the right.
@ -558,11 +556,9 @@
(is-a?/c style-delta%))
(()
((white-on-black? #f)))
@{This delta is designed for use with
@method[text% set-clickback].
@{This delta is designed for use with @method[text% set-clickback].
Use the result of this function as the style
for the region
text where the clickback is set.
for the region text where the clickback is set.
If @scheme[white-on-black?] is true, the function returns
a delta suitable for use on a black background.