diff scripts/general/genvarname.m @ 14327:4d917a6a858b stable

doc: Use Octave coding conventions in @example blocks of docstrings. * accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m, celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m, contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m, dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m, ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m, flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m, idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m, isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m, logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m, moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m, polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m, randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m, shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m, strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m, subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m, voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in @example blocks of docstrings.
author Rik <octave@nomad.inbox5.com>
date Sat, 04 Feb 2012 22:12:50 -0800
parents 72c96de7a403
children f3d52523cde1
line wrap: on
line diff
--- a/scripts/general/genvarname.m	Sat Feb 04 10:29:50 2012 -0500
+++ b/scripts/general/genvarname.m	Sat Feb 04 22:12:50 2012 -0800
@@ -30,7 +30,7 @@
 ## @group
 ## x = 3.141;
 ## genvarname ("x", who ())
-## @result{} x1
+##   @result{} x1
 ## @end group
 ## @end example
 ##
@@ -40,11 +40,11 @@
 ## @example
 ## @group
 ## genvarname (@{"foo", "foo"@})
-## @result{}
-## @{
-##   [1,1] = foo
-##   [1,2] = foo1
-## @}
+##   @result{}
+##      @{
+##        [1,1] = foo
+##        [1,2] = foo1
+##      @}
 ## @end group
 ## @end example
 ##
@@ -55,8 +55,8 @@
 ## @example
 ## @group
 ## name = genvarname ("x");
-## eval([name " = 42"]);
-## @result{} x =  42
+## eval ([name " = 42"]);
+##   @result{} x =  42
 ## @end group
 ## @end example
 ##
@@ -68,13 +68,12 @@
 ## for i = 1:3
 ##   x.(genvarname ("a", fieldnames (x))) = i;
 ## endfor
-## @result{}
-## x =
-## @{
-##   a =  1
-##   a1 =  2
-##   a2 =  3
-## @}
+##   @result{} x =
+##      @{
+##        a =  1
+##        a1 =  2
+##        a2 =  3
+##      @}
 ## @end group
 ## @end example
 ##