Mercurial > octave
diff scripts/gui/warndlg.m @ 26035:0a39db17170c
doc: Clean up docstrings for XXXdlg.m functions
* errordlg.m, helpdlg.m, inputdlg.m, listdlg.m, msgbox.m, uicontrol.m,
warndlg.m: Use TexInfo macro @: to stop interpretation of '.' in message
as an end-of-sentence period. Correct typo 'optionnal' -> 'optional'.
Wrap long lines. Correct typo 'elment' -> 'element'. Wrap "keypressfcn"
in @qcode macro.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 05 Nov 2018 11:07:10 -0800 |
| parents | 700b3f415ebe |
| children | 00f796120a6d |
line wrap: on
line diff
--- a/scripts/gui/warndlg.m Mon Nov 05 09:34:22 2018 -0800 +++ b/scripts/gui/warndlg.m Mon Nov 05 11:07:10 2018 -0800 @@ -25,13 +25,14 @@ ## Display a warning dialog box with warning message @var{msg} and caption ## @var{title}. ## -## The default warning message is @qcode{"This is the default warning string."} -## and the default caption is @qcode{"Warning Dialog"}. +## The default warning message is +## @qcode{"This is the default warning string.@:"} and the default caption is +## @qcode{"Warning Dialog"}. ## ## The warning message may have multiple lines separated by newline characters ## ("\n"), or it may be a cellstr array with one element for each line. ## -## The third optionnal argument @var{opt} controls the behavior of the dialog. +## The third optional argument @var{opt} controls the behavior of the dialog. ## See @code{msgbox} for details. ## ## The return value @var{h} is a handle to the figure object used for