diff libinterp/octave-value/ov.cc @ 20163:075a5e2e1ba5 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 21:52:42 -0700
parents 17d647821d61
children
line wrap: on
line diff
--- a/libinterp/octave-value/ov.cc	Sun May 03 17:00:11 2015 -0700
+++ b/libinterp/octave-value/ov.cc	Sun May 03 21:52:42 2015 -0700
@@ -3024,17 +3024,15 @@
 DEFUN (subsref, args, nargout,
        "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} subsref (@var{val}, @var{idx})\n\
-Perform the subscripted element selection operation according to\n\
-the subscript specified by @var{idx}.\n\
+Perform the subscripted element selection operation according to the\n\
+subscript specified by @var{idx}.\n\
 \n\
-The subscript @var{idx} is expected to be a structure array with\n\
-fields @samp{type} and @samp{subs}.  Valid values for @samp{type}\n\
-are @samp{\"()\"}, @samp{\"@{@}\"}, and @samp{\".\"}.\n\
-The @samp{subs} field may be either @samp{\":\"} or a cell array\n\
-of index values.\n\
+The subscript @var{idx} is expected to be a structure array with fields\n\
+@samp{type} and @samp{subs}.  Valid values for @samp{type} are\n\
+@samp{\"()\"}, @samp{\"@{@}\"}, and @samp{\".\"}.  The @samp{subs} field may\n\
+be either @samp{\":\"} or a cell array of index values.\n\
 \n\
-The following example shows how to extract the first two columns of\n\
-a matrix\n\
+The following example shows how to extract the first two columns of a matrix\n\
 \n\
 @example\n\
 @group\n\
@@ -3054,8 +3052,8 @@
 @noindent\n\
 Note that this is the same as writing @code{val(:,1:2)}.\n\
 \n\
-If @var{idx} is an empty structure array with fields @samp{type}\n\
-and @samp{subs}, return @var{val}.\n\
+If @var{idx} is an empty structure array with fields @samp{type} and\n\
+@samp{subs}, return @var{val}.\n\
 @seealso{subsasgn, substruct}\n\
 @end deftypefn")
 {
@@ -3087,17 +3085,16 @@
 DEFUN (subsasgn, args, ,
        "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} subsasgn (@var{val}, @var{idx}, @var{rhs})\n\
-Perform the subscripted assignment operation according to\n\
-the subscript specified by @var{idx}.\n\
+Perform the subscripted assignment operation according to the subscript\n\
+specified by @var{idx}.\n\
 \n\
-The subscript @var{idx} is expected to be a structure array with\n\
-fields @samp{type} and @samp{subs}.  Valid values for @samp{type}\n\
-are @samp{\"()\"}, @samp{\"@{@}\"}, and @samp{\".\"}.\n\
-The @samp{subs} field may be either @samp{\":\"} or a cell array\n\
-of index values.\n\
+The subscript @var{idx} is expected to be a structure array with fields\n\
+@samp{type} and @samp{subs}.  Valid values for @samp{type} are\n\
+@samp{\"()\"}, @samp{\"@{@}\"}, and @samp{\".\"}.  The @samp{subs} field may\n\
+be either @samp{\":\"} or a cell array of index values.\n\
 \n\
-The following example shows how to set the two first columns of a\n\
-3-by-3 matrix to zero.\n\
+The following example shows how to set the two first columns of a 3-by-3\n\
+matrix to zero.\n\
 \n\
 @example\n\
 @group\n\
@@ -3113,8 +3110,8 @@
 \n\
 Note that this is the same as writing @code{val(:,1:2) = 0}.\n\
 \n\
-If @var{idx} is an empty structure array with fields @samp{type}\n\
-and @samp{subs}, return @var{rhs}.\n\
+If @var{idx} is an empty structure array with fields @samp{type} and\n\
+@samp{subs}, return @var{rhs}.\n\
 @seealso{subsref, substruct}\n\
 @end deftypefn")
 {
@@ -3279,9 +3276,10 @@
 @deftypefnx {Built-in Function} {@var{old_val} =} disable_permutation_matrix (@var{new_val})\n\
 @deftypefnx {Built-in Function} {} disable_permutation_matrix (@var{new_val}, \"local\")\n\
 Query or set the internal variable that controls whether permutation\n\
-matrices are stored in a special space-efficient format.  The default\n\
-value is true.  If this option is disabled Octave will store permutation\n\
-matrices as full matrices.\n\
+matrices are stored in a special space-efficient format.\n\
+\n\
+The default value is true.  If this option is disabled Octave will store\n\
+permutation matrices as full matrices.\n\
 \n\
 When called from inside a function with the @qcode{\"local\"} option, the\n\
 variable is changed locally for the function and any subroutines it calls.\n\
@@ -3308,9 +3306,10 @@
 @deftypefnx {Built-in Function} {@var{old_val} =} disable_diagonal_matrix (@var{new_val})\n\
 @deftypefnx {Built-in Function} {} disable_diagonal_matrix (@var{new_val}, \"local\")\n\
 Query or set the internal variable that controls whether diagonal\n\
-matrices are stored in a special space-efficient format.  The default\n\
-value is true.  If this option is disabled Octave will store diagonal\n\
-matrices as full matrices.\n\
+matrices are stored in a special space-efficient format.\n\
+\n\
+The default value is true.  If this option is disabled Octave will store\n\
+diagonal matrices as full matrices.\n\
 \n\
 When called from inside a function with the @qcode{\"local\"} option, the\n\
 variable is changed locally for the function and any subroutines it calls.\n\
@@ -3351,8 +3350,10 @@
 @deftypefnx {Built-in Function} {@var{old_val} =} disable_range (@var{new_val})\n\
 @deftypefnx {Built-in Function} {} disable_range (@var{new_val}, \"local\")\n\
 Query or set the internal variable that controls whether ranges are stored\n\
-in a special space-efficient format.  The default value is true.  If this\n\
-option is disabled Octave will store ranges as full matrices.\n\
+in a special space-efficient format.\n\
+\n\
+The default value is true.  If this option is disabled Octave will store\n\
+ranges as full matrices.\n\
 \n\
 When called from inside a function with the @qcode{\"local\"} option, the\n\
 variable is changed locally for the function and any subroutines it calls.\n\