Mercurial > octave
changeset 22429:00986ee43956
doc: Add more @seealso links to numel, size, size_equal.
* data.cc (Fsize_equal): Clarify docstring about calling with no argument.
Add @seealso link to common_size.
* data.cc (Fsize): Add @seealso link to size_equal, common_size.
* data.cc (Fnumel): Add @seealso link to length, ndims.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 02 Sep 2016 08:54:41 -0700 |
| parents | 994dc0f7a6ce |
| children | 18b863e3b1e2 |
| files | libinterp/corefcn/data.cc |
| diffstat | 1 files changed, 5 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/data.cc Fri Sep 02 08:33:13 2016 -0700 +++ b/libinterp/corefcn/data.cc Fri Sep 02 08:54:41 2016 -0700 @@ -2726,7 +2726,7 @@ This method is also called when an object appears as lvalue with cs-list indexing, i.e., @code{object@{@dots{}@}} or @code{object(@dots{}).field}. -@seealso{size} +@seealso{size, length, ndims} @end deftypefn */) { int nargin = args.length (); @@ -2782,7 +2782,7 @@ @noindent returns the number of columns in the given matrix. -@seealso{numel, ndims, length, rows, columns} +@seealso{numel, ndims, length, rows, columns, size_equal, common_size} @end deftypefn */) { octave_value_list retval; @@ -2840,9 +2840,9 @@ @deftypefn {} {} size_equal (@var{a}, @var{b}, @dots{}) Return true if the dimensions of all arguments agree. -Trailing singleton dimensions are ignored. -When called with a single or no argument @code{size_equal} returns true. -@seealso{size, numel, ndims} +Trailing singleton dimensions are ignored. When called with a single argument, +or no argument, @code{size_equal} returns true. +@seealso{size, numel, ndims, common_size} @end deftypefn */) { int nargin = args.length ();