diff scripts/java/errordlg.m @ 15748:54e8c2527a9e

style and doc fixes for newly imported Java package .m files * java/cell2mlstr.m, java/errordlg.m, java/helpdlg.m, java/inputdlg.m, java/javaArray.m, java/javaaddpath.m, java/javaclasspath.m, java/javafields.m, java/javamem.m, java/javamethods.m, java/javarmpath.m, java/listdlg.m, java/msgbox.m java/questdlg.m, java/warndlg.m: Style and doc fixes.
author John W. Eaton <jwe@octave.org>
date Fri, 07 Dec 2012 17:21:27 -0500
parents da26f72408a7
children 05c781cca57e
line wrap: on
line diff
--- a/scripts/java/errordlg.m
+++ b/scripts/java/errordlg.m
@@ -17,17 +17,19 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function file} {@var{P} =} errordlg (@var{MESSAGE} [,@var{TITLE}])
+## @deftypefn {Function file} {@var{p} =} errordlg (@var{msg}, @var{title})
+## Display @var{msg} using an error dialog box.
 ##
-## Displays the @var{MESSAGE} (character string or cell string array for
-## multi-line text) using an error dialog box. 
-## @var{TITLE} can be used optionally to decorate the dialog caption.
+## The message may have multiple lines separated by newline characters
+## (@code{"\n"}), or it may be a cellstr array with one element for each
+## line.  The optional @var{title} (character string) can be used to
+## decorate the dialog caption.
+##
 ## The return value is always 1.
-##
+## @seealso{helpdlg, inputdlg, listdlg, questdlg, warndlg}
 ## @end deftypefn
-## @seealso{helpdlg, inputdlg, listdlg, questdlg, warndlg}
 
-function ret = errordlg (message, varargin)
+function retval = errordlg (message, varargin)
 
   if (! ischar (message))
     if (iscell (message))
@@ -38,9 +40,10 @@
   endif
 
   switch length (varargin)
-  case 0
-    title = "Error Dialog";
-  otherwise
+    case 0
+      title = "Error Dialog";
+
+    otherwise
       title = varargin{1};
   endswitch
 
@@ -48,6 +51,6 @@
     error ("errordlg: character string expected for title");
   endif
 
-  ret = java_invoke ("org.octave.JDialogBox", "errordlg", message, title);
+  retval = java_invoke ("org.octave.JDialogBox", "errordlg", message, title);
 
 endfunction