Mercurial > octave-antonio

comparison libinterp/octave-value/ov-class.cc @ 20163:075a5e2e1ba5 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 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 107130a0490c
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
1861 DEFUN (class, args, , 1861 DEFUN (class, args, ,
1862 "-*- texinfo -*-\n\ 1862 "-*- texinfo -*-\n\
1863 @deftypefn {Function File} {@var{classname} =} class (@var{obj})\n\ 1863 @deftypefn {Function File} {@var{classname} =} class (@var{obj})\n\
1864 @deftypefnx {Function File} {} class (@var{s}, @var{id})\n\ 1864 @deftypefnx {Function File} {} class (@var{s}, @var{id})\n\
1865 @deftypefnx {Function File} {} class (@var{s}, @var{id}, @var{p}, @dots{})\n\ 1865 @deftypefnx {Function File} {} class (@var{s}, @var{id}, @var{p}, @dots{})\n\
1866 Return the class of the object @var{obj} or create a class with\n\ 1866 Return the class of the object @var{obj}, or create a class with\n\
1867 fields from structure @var{s} and name (string) @var{id}. Additional\n\ 1867 fields from structure @var{s} and name (string) @var{id}.\n\
1868 arguments name a list of parent classes from which the new class is\n\ 1868 \n\
1869 derived.\n\ 1869 Additional arguments name a list of parent classes from which the new class\n\
1870 is derived.\n\
1870 @seealso{typeinfo, isa}\n\ 1871 @seealso{typeinfo, isa}\n\
1871 @end deftypefn") 1872 @end deftypefn")
1872 { 1873 {
1873 octave_value retval; 1874 octave_value retval;
1874 1875
2207 DEFUN (superiorto, args, , 2208 DEFUN (superiorto, args, ,
2208 "-*- texinfo -*-\n\ 2209 "-*- texinfo -*-\n\
2209 @deftypefn {Built-in Function} {} superiorto (@var{class_name}, @dots{})\n\ 2210 @deftypefn {Built-in Function} {} superiorto (@var{class_name}, @dots{})\n\
2210 When called from a class constructor, mark the object currently\n\ 2211 When called from a class constructor, mark the object currently\n\
2211 constructed as having a higher precedence than @var{class_name}.\n\ 2212 constructed as having a higher precedence than @var{class_name}.\n\
2213 \n\
2212 More that one such class can be specified in a single call.\n\ 2214 More that one such class can be specified in a single call.\n\
2213 This function may only be called from a class constructor.\n\ 2215 This function may only be called from a class constructor.\n\
2214 @seealso{inferiorto}\n\ 2216 @seealso{inferiorto}\n\
2215 @end deftypefn") 2217 @end deftypefn")
2216 { 2218 {
2252 DEFUN (inferiorto, args, , 2254 DEFUN (inferiorto, args, ,
2253 "-*- texinfo -*-\n\ 2255 "-*- texinfo -*-\n\
2254 @deftypefn {Built-in Function} {} inferiorto (@var{class_name}, @dots{})\n\ 2256 @deftypefn {Built-in Function} {} inferiorto (@var{class_name}, @dots{})\n\
2255 When called from a class constructor, mark the object currently\n\ 2257 When called from a class constructor, mark the object currently\n\
2256 constructed as having a lower precedence than @var{class_name}.\n\ 2258 constructed as having a lower precedence than @var{class_name}.\n\
2259 \n\
2257 More that one such class can be specified in a single call.\n\ 2260 More that one such class can be specified in a single call.\n\
2258 This function may only be called from a class constructor.\n\ 2261 This function may only be called from a class constructor.\n\
2259 @seealso{superiorto}\n\ 2262 @seealso{superiorto}\n\
2260 @end deftypefn") 2263 @end deftypefn")
2261 { 2264 {