Mercurial > octave
diff libinterp/octave-value/ov.cc @ 21072:a9ed4104ecfd
doc: Rewrite documentation for Object Oriented Programming.
* octave.texi: Rename "Manipulating Classes" node to "Class Methods"
* oop.txi: Rewrite signicant parts of Object Oriented Programming chapter.
* examples/code/@FIRfilter/subsasgn.m, examples/code/@FIRfilter/subsref.m,
examples/code/@polynomial/get.m, examples/code/@polynomial/subsasgn.m:
Enclose property in error messages in double quotes ("%s").
* examples/code/@polynomial/subsref.m: Rename input object to 'p'.
Rename variable "ind" to "idx". Enclose property in error messages in double
quotes ("%s").
* ov-class.cc (Fsuperiorto, Finferiorto): Improve docstrings.
* ov-usr-fcn.cc (Foptimize_subsasgn_calls): Improve docstring.
* ov.cc (Fsubsref, Fsubsasgn): Improve docstrings.
* display.m: Rewrite docstring. Rename input variable to "obj". Remove unused
output variable from function declaration.
* subsindex.m: Rename input variable to "obj". Rewrite examples in docstring.
Add input validation and BIST tests to m-file.
| author | Rik <rik@octave.org> |
|---|---|
| date | Thu, 14 Jan 2016 13:30:22 -0800 |
| parents | 3e7cfee5f786 |
| children | 49852ff04747 |
line wrap: on
line diff
--- a/libinterp/octave-value/ov.cc Thu Jan 14 14:00:32 2016 -0500 +++ b/libinterp/octave-value/ov.cc Thu Jan 14 13:30:22 2016 -0800 @@ -2981,13 +2981,13 @@ DEFUN (subsref, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {} subsref (@var{val}, @var{idx})\n\ -Perform the subscripted element selection operation according to the\n\ -subscript specified by @var{idx}.\n\ +Perform the subscripted element selection operation on @var{val} according\n\ +to the subscript specified by @var{idx}.\n\ \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\ +The subscript @var{idx} must be a structure array with fields @samp{type}\n\ +and @samp{subs}. Valid values for @samp{type} are @qcode{\"()\"},\n\ +@qcode{\"@{@}\"}, and @qcode{\".\"}. The @samp{subs} field may be either\n\ +@qcode{\":\"} or a cell array of index values.\n\ \n\ The following example shows how to extract the first two columns of a matrix\n\ \n\ @@ -3007,7 +3007,7 @@ @end example\n\ \n\ @noindent\n\ -Note that this is the same as writing @code{val(:,1:2)}.\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} and\n\ @samp{subs}, return @var{val}.\n\ @@ -3040,10 +3040,10 @@ 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 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\ +The subscript @var{idx} must be a structure array with fields @samp{type}\n\ +and @samp{subs}. Valid values for @samp{type} are @qcode{\"()\"},\n\ +@qcode{\"@{@}\"}, and @qcode{\".\"}. The @samp{subs} field may be either\n\ +@qcode{\":\"} or a cell array of index values.\n\ \n\ The following example shows how to set the two first columns of a 3-by-3\n\ matrix to zero.\n\ @@ -3060,11 +3060,11 @@ @end group\n\ @end example\n\ \n\ -Note that this is the same as writing @code{val(:,1:2) = 0}.\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} and\n\ @samp{subs}, return @var{rhs}.\n\ -@seealso{subsref, substruct}\n\ +@seealso{subsref, substruct, optimize_subsasgn_calls}\n\ @end deftypefn") { if (args.length () != 3)