comparison scripts/java/usejava.m @ 30875:5d3faba0342e

doc: Ensure documentation lists output argument when it exists for all m-files. For new users of Octave it is best to show explicit calling forms in the documentation and to show a return argument when it exists. * bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m, fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m, polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m, structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m, uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m, __additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m, usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m, flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m, duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m, compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m, inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m, namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m, verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m, matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m, camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m, thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m, ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m, zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m, __actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m, print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m, rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m, polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m, prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m, arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m, hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m, sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m, ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m, betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m, gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m, sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m, toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m, mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m, run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m, bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m, hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m, strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m, __prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m, calendar.m, ctime.m, date.m, etime.m: Add return arguments to @deftypefn macros where they were missing. Rename variables in functions (particularly generic "retval") to match documentation. Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax' to indicate it is a graphics handle to an axes object).
author Rik <rik@octave.org>
date Wed, 30 Mar 2022 20:40:27 -0700
parents 796f54d4ddbf
children 597f3ee61a48
comparison
equal deleted inserted replaced
30874:2b07748dbae3 30875:5d3faba0342e
22 ## <https://www.gnu.org/licenses/>. 22 ## <https://www.gnu.org/licenses/>.
23 ## 23 ##
24 ######################################################################## 24 ########################################################################
25 25
26 ## -*- texinfo -*- 26 ## -*- texinfo -*-
27 ## @deftypefn {} {} usejava (@var{feature}) 27 ## @deftypefn {} {@var{tf} =} usejava (@var{feature})
28 ## Return true if the Java element @var{feature} is available. 28 ## Return true if the Java element @var{feature} is available.
29 ## 29 ##
30 ## Possible features are: 30 ## Possible features are:
31 ## 31 ##
32 ## @table @asis 32 ## @table @asis
50 ## desktop. Other features may be available if Octave was compiled with the 50 ## desktop. Other features may be available if Octave was compiled with the
51 ## Java Interface and Java is installed. 51 ## Java Interface and Java is installed.
52 ## @seealso{javachk} 52 ## @seealso{javachk}
53 ## @end deftypefn 53 ## @end deftypefn
54 54
55 function retval = usejava (feature) 55 function tf = usejava (feature)
56 56
57 if (nargin < 1 || ! ischar (feature)) 57 if (nargin < 1 || ! ischar (feature))
58 print_usage (); 58 print_usage ();
59 endif 59 endif
60 60
61 retval = false; 61 tf = false;
62 62
63 switch (feature) 63 switch (feature)
64 ## For each feature, try methods() on a Java class of a feature 64 ## For each feature, try methods() on a Java class of a feature
65 case "awt" 65 case "awt"
66 try 66 try
67 dum = methods ("java.awt.Frame"); 67 dum = methods ("java.awt.Frame");
68 retval = ! javaMethod ("isHeadless", "java.awt.GraphicsEnvironment"); 68 tf = ! javaMethod ("isHeadless", "java.awt.GraphicsEnvironment");
69 end_try_catch 69 end_try_catch
70 case "desktop" 70 case "desktop"
71 ## Octave has no Java based GUI/desktop, leave retval = false 71 ## Octave has no Java based GUI/desktop, leave tf = false
72 case "jvm" 72 case "jvm"
73 try 73 try
74 dum = methods ("java.lang.Runtime"); 74 dum = methods ("java.lang.Runtime");
75 retval = true; 75 tf = true;
76 end_try_catch 76 end_try_catch
77 case "swing" 77 case "swing"
78 try 78 try
79 dum = methods ("javax.swing.Popup"); 79 dum = methods ("javax.swing.Popup");
80 retval = ! javaMethod ("isHeadless", "java.awt.GraphicsEnvironment"); 80 tf = ! javaMethod ("isHeadless", "java.awt.GraphicsEnvironment");
81 end_try_catch 81 end_try_catch
82 otherwise 82 otherwise
83 error ("usejava: unrecognized FEATURE '%s'", feature); 83 error ("usejava: unrecognized FEATURE '%s'", feature);
84 endswitch 84 endswitch
85 85