Mercurial > octave

comparison scripts/miscellaneous/edit.m @ 21546:f7f97d7e9294

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Wrap m-file docstrings to 79 characters + newline (80 total). * isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m, inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m, validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m, cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m, warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m, ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m, pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m, line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m, surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m, rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m, histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m: Wrap m-file docstrings to 79 characters + newline (80 total).
author Rik <rik@octave.org>
date Sun, 27 Mar 2016 15:50:01 -0700
parents b0920076dd98
children 17845d0e359f
comparison
equal deleted inserted replaced
21545:a81c9a0a05e3 21546:f7f97d7e9294
42 ## function along with its current definition. 42 ## function along with its current definition.
43 ## 43 ##
44 ## @item 44 ## @item
45 ## If @code{@var{name}.cc} is specified, then it will search for 45 ## If @code{@var{name}.cc} is specified, then it will search for
46 ## @code{@var{name}.cc} in the path and try to modify it, otherwise it will 46 ## @code{@var{name}.cc} in the path and try to modify it, otherwise it will
47 ## create a new @file{.cc} file in the current directory. If @var{name} happens 47 ## create a new @file{.cc} file in the current directory. If @var{name}
48 ## to be an m-file or interpreter defined function, then the text of that 48 ## happens to be an m-file or interpreter defined function, then the text of
49 ## function will be inserted into the .cc file as a comment. 49 ## that function will be inserted into the .cc file as a comment.
50 ## 50 ##
51 ## @item 51 ## @item
52 ## If @file{@var{name}.ext} is on your path then it will be edited, otherwise 52 ## If @file{@var{name}.ext} is on your path then it will be edited, otherwise
53 ## the editor will be started with @file{@var{name}.ext} in the current 53 ## the editor will be started with @file{@var{name}.ext} in the current
54 ## directory as the filename. If @file{@var{name}.ext} is not modifiable, 54 ## directory as the filename. If @file{@var{name}.ext} is not modifiable,
61 ## @end itemize 61 ## @end itemize
62 ## 62 ##
63 ## If @code{edit} is called with @var{field} and @var{value} variables, the 63 ## If @code{edit} is called with @var{field} and @var{value} variables, the
64 ## value of the control field @var{field} will be set to @var{value}. 64 ## value of the control field @var{field} will be set to @var{value}.
65 ## 65 ##
66 ## If an output argument is requested and the first input argument is @code{get} 66 ## If an output argument is requested and the first input argument is
67 ## then @code{edit} will return the value of the control field @var{field}. 67 ## @code{get} then @code{edit} will return the value of the control field
68 ## If the control field does not exist, edit will return a structure 68 ## @var{field}. If the control field does not exist, edit will return a
69 ## containing all fields and values. Thus, @code{edit ("get", "all")} returns 69 ## structure containing all fields and values. Thus, @code{edit ("get",
70 ## a complete control structure. 70 ## "all")} returns a complete control structure.
71 ## 71 ##
72 ## The following control fields are used: 72 ## The following control fields are used:
73 ## 73 ##
74 ## @table @samp 74 ## @table @samp
75 ## @item home 75 ## @item home