Mercurial > octave-antonio

diff 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
line wrap: on
line diff
--- a/scripts/prefs/getpref.m	Sun May 03 12:58:42 2015 -0700
+++ b/scripts/prefs/getpref.m	Sun May 03 15:36:23 2015 -0700
@@ -17,26 +17,29 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} getpref (@var{group}, @var{pref}, @var{default})
-## Return the preference value corresponding to the named preference
-## @var{pref} in the preference group @var{group}.
+## @deftypefn  {Function File} {} getpref (@var{group}, @var{pref})
+## @deftypefnx {Function File} {} getpref (@var{group}, @var{pref}, @var{default})
+## @deftypefnx {Function File} {} getpref (@var{group})
+## Return the preference value corresponding to the named preference @var{pref}
+## in the preference group @var{group}.
 ##
 ## The named preference group must be a character string.
 ##
 ## If @var{pref} does not exist in @var{group} and @var{default} is
 ## specified, return @var{default}.
 ##
-## The preference @var{pref} may be a character string or a cell array
-## of character strings.  The corresponding default value @var{default}
-## may be any value, or, if @var{pref} is a cell array of strings,
-## @var{default} must be a cell array of values with the same size as
-## @var{pref}.
+## The preference @var{pref} may be a character string or a cell array of
+## character strings.
 ##
-## If neither @var{pref} nor @var{default} are specified, return a
-## structure of preferences for the preference group @var{group}.
+## The corresponding default value @var{default} may be any value, or, if
+## @var{pref} is a cell array of strings, @var{default} must be a cell array
+## of values with the same size as @var{pref}.
 ##
-## If no arguments are specified, return a structure containing all
-## groups of preferences and their values.
+## If neither @var{pref} nor @var{default} are specified, return a structure
+## of preferences for the preference group @var{group}.
+##
+## If no arguments are specified, return a structure containing all groups of
+## preferences and their values.
 ## @seealso{addpref, setpref, ispref, rmpref}
 ## @end deftypefn