Mercurial > octave-nkf
diff src/ov-null-mat.cc @ 11431:0d9640d755b1
Improve docstrings for all isXXX functions.
Use 'return true' rather than 'return 1'.
Improve the cross-referencing through seealso links.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 31 Dec 2010 13:20:44 -0800 |
| parents | a4f482e66b65 |
| children | fd0a3ac60b0e |
line wrap: on
line diff
--- a/src/ov-null-mat.cc Fri Dec 31 09:56:44 2010 -0800 +++ b/src/ov-null-mat.cc Fri Dec 31 13:20:44 2010 -0800 @@ -91,11 +91,11 @@ DEFUN (isnull, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isnull (@var{x})\n\ -Return 1 if @var{x} is a special null matrix, string or single quoted string.\n\ -Indexed assignment with such a value as right-hand side should delete array\n\ -elements. This function should be used when overloading indexed assignment\n\ -for user-defined classes instead of @code{isempty}, to distinguish the\n\ -cases:\n\ +Return true if @var{x} is a special null matrix, string, or single quoted\n\ +string. Indexed assignment with such a value on the right-hand side should\n\ +delete array elements. This function should be used when overloading\n\ +indexed assignment for user-defined classes instead of @code{isempty}, to\n\ +distinguish the cases:\n\ @table @asis\n\ @item @code{A(I) = []}\n\ This should delete elements if @code{I} is nonempty.\n\ @@ -103,6 +103,7 @@ @item @code{X = []; A(I) = X}\n\ This should give an error if @code{I} is nonempty.\n\ @end table\n\ +@seealso{isempty, isindex}\n\ @end deftypefn") { octave_value retval;