diff scripts/java/helpdlg.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/helpdlg.m
+++ b/scripts/java/helpdlg.m
@@ -17,20 +17,19 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function file} {@var{P} =} helpdlg (@var{MESSAGE} [,@var{TITLE}])
-##
-## Displays a @var{MESSAGE} in a help dialog box.
+## @deftypefn {Function file} {@var{p} =} helpdlg (@var{msg} ,@var{title}])
+## Display @var{msg} in a help dialog box.
 ##
-## @var{message} can have multiple lines separated by newline characters
-## ("\n"), or it can be a cellstr array (one element for each line).
-## The optional @var{TITLE} (character string) can be used 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{errordlg, inputdlg, listdlg, questdlg, warndlg}
 ## @end deftypefn
-## @seealso{errordlg, inputdlg, listdlg, questdlg, warndlg}
 
-function ret = helpdlg (message, varargin)
+function retval = helpdlg (message, varargin)
 
   if (! ischar (message))
     if (iscell (message))
@@ -41,20 +40,21 @@
   endif
   
   switch length (varargin)
-  case 0
-     title = "Help Dialog";
-  otherwise
-    if (ischar (varargin {1}))
-      title = varargin{1};
-    else
-      error ("helpdlg: character string expected for title");
-    endif
+    case 0
+      title = "Help Dialog";
+
+    otherwise
+      if (ischar (varargin {1}))
+        title = varargin{1};
+      else
+        error ("helpdlg: character string expected for title");
+      endif
   endswitch
 
   if (! ischar (title))
     error ("helpdlg: character string expected for title");
   endif
 
-  ret = java_invoke ("org.octave.JDialogBox", "helpdlg", message, title);
+  retval = java_invoke ("org.octave.JDialogBox", "helpdlg", message, title);
 
 endfunction