Mercurial > octave-antonio
comparison scripts/prefs/setpref.m @ 20160:03b9d17a2d95 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed io, java, linear-algebra, prefs, and set script directories.
* scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m,
scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m,
scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m,
scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m,
scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m,
scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m,
scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m,
scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m,
scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m,
scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m,
scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m,
scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m,
scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m,
scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m,
scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m,
scripts/set/powerset.m, scripts/set/setdiff.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 15:36:23 -0700 |
parents | 9fc020886ae9 |
children |
comparison
equal
deleted
inserted
replaced
20159:597991b19e40 | 20160:03b9d17a2d95 |
---|---|
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {} setpref (@var{group}, @var{pref}, @var{val}) | 20 ## @deftypefn {Function File} {} setpref (@var{group}, @var{pref}, @var{val}) |
21 ## Set a preference @var{pref} to the given @var{val} in the named | 21 ## Set a preference @var{pref} to the given @var{val} in the named preference |
22 ## preference group @var{group}. | 22 ## group @var{group}. |
23 ## | 23 ## |
24 ## The named preference group must be a character string. | 24 ## The named preference group must be a character string. |
25 ## | 25 ## |
26 ## The preference @var{pref} may be a character string or a cell array | 26 ## The preference @var{pref} may be a character string or a cell array of |
27 ## of character strings. The corresponding value @var{val} may be any | 27 ## character strings. |
28 ## value, or, if @var{pref} is a cell array of strings, @var{val} | 28 ## |
29 ## must be a cell array of values with the same size as @var{pref}. | 29 ## The corresponding value @var{val} may be any value, or, if @var{pref} is a |
30 ## cell array of strings, @var{val} must be a cell array of values with the | |
31 ## same size as @var{pref}. | |
30 ## | 32 ## |
31 ## If the named preference or group does not exist, it is added. | 33 ## If the named preference or group does not exist, it is added. |
32 ## @seealso{addpref, getpref, ispref, rmpref} | 34 ## @seealso{addpref, getpref, ispref, rmpref} |
33 ## @end deftypefn | 35 ## @end deftypefn |
34 | 36 |