Mercurial > octave-antonio

comparison scripts/prefs/getpref.m @ 20160:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
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} {} getpref (@var{group}, @var{pref}, @var{default}) 20 ## @deftypefn {Function File} {} getpref (@var{group}, @var{pref})
21 ## Return the preference value corresponding to the named preference 21 ## @deftypefnx {Function File} {} getpref (@var{group}, @var{pref}, @var{default})
22 ## @var{pref} in the preference group @var{group}. 22 ## @deftypefnx {Function File} {} getpref (@var{group})
23 ## Return the preference value corresponding to the named preference @var{pref}
24 ## in the preference group @var{group}.
23 ## 25 ##
24 ## The named preference group must be a character string. 26 ## The named preference group must be a character string.
25 ## 27 ##
26 ## If @var{pref} does not exist in @var{group} and @var{default} is 28 ## If @var{pref} does not exist in @var{group} and @var{default} is
27 ## specified, return @var{default}. 29 ## specified, return @var{default}.
28 ## 30 ##
29 ## The preference @var{pref} may be a character string or a cell array 31 ## The preference @var{pref} may be a character string or a cell array of
30 ## of character strings. The corresponding default value @var{default} 32 ## character strings.
31 ## may be any value, or, if @var{pref} is a cell array of strings,
32 ## @var{default} must be a cell array of values with the same size as
33 ## @var{pref}.
34 ## 33 ##
35 ## If neither @var{pref} nor @var{default} are specified, return a 34 ## The corresponding default value @var{default} may be any value, or, if
36 ## structure of preferences for the preference group @var{group}. 35 ## @var{pref} is a cell array of strings, @var{default} must be a cell array
36 ## of values with the same size as @var{pref}.
37 ## 37 ##
38 ## If no arguments are specified, return a structure containing all 38 ## If neither @var{pref} nor @var{default} are specified, return a structure
39 ## groups of preferences and their values. 39 ## of preferences for the preference group @var{group}.
40 ##
41 ## If no arguments are specified, return a structure containing all groups of
42 ## preferences and their values.
40 ## @seealso{addpref, setpref, ispref, rmpref} 43 ## @seealso{addpref, setpref, ispref, rmpref}
41 ## @end deftypefn 44 ## @end deftypefn
42 45
43 ## Author: jwe 46 ## Author: jwe
44 47