Mercurial > hg > octave-nkf
diff libinterp/corefcn/graphics.cc @ 20382:4f45eaf83908 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed libinterp/corefcn directory.
* libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc,
libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc,
libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc,
libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc,
libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc,
libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc,
libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc,
libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc,
libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc,
libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc,
libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc,
libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc,
libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc,
libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, scripts/polynomial/spline.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 09 May 2015 17:19:30 -0700 |
parents | 1f9ed81bd173 |
children | aa36fb998a4d |
line wrap: on
line diff
--- a/libinterp/corefcn/graphics.cc +++ b/libinterp/corefcn/graphics.cc @@ -9767,9 +9767,9 @@ @deftypefn {Built-in Function} {} ishandle (@var{h})\n\ Return true if @var{h} is a graphics handle and false otherwise.\n\ \n\ -@var{h} may also be a matrix of handles in which case a logical\n\ -array is returned that is true where the elements of @var{h} are\n\ -graphics handles and false where they are not.\n\ +@var{h} may also be a matrix of handles in which case a logical array is\n\ +returned that is true where the elements of @var{h} are graphics handles and\n\ +false where they are not.\n\ @seealso{isaxes, isfigure}\n\ @end deftypefn") { @@ -10008,6 +10008,7 @@ @deftypefnx {Built-in Function} {@var{all_value_list} =} set (@var{h})\n\ Set named property values for the graphics handle (or vector of graphics\n\ handles) @var{h}.\n\ +\n\ There are three ways to give the property names and values:\n\ \n\ @itemize\n\ @@ -10200,9 +10201,12 @@ @deftypefn {Built-in Function} {@var{val} =} get (@var{h})\n\ @deftypefnx {Built-in Function} {@var{val} =} get (@var{h}, @var{p})\n\ Return the value of the named property @var{p} from the graphics handle\n\ -@var{h}. If @var{p} is omitted, return the complete property list for\n\ -@var{h}. If @var{h} is a vector, return a cell array including the property\n\ -values or lists respectively.\n\ +@var{h}.\n\ +\n\ +If @var{p} is omitted, return the complete property list for @var{h}.\n\ +\n\ +If @var{h} is a vector, return a cell array including the property values or\n\ +lists respectively.\n\ @seealso{set}\n\ @end deftypefn") { @@ -10649,8 +10653,9 @@ DEFUN (__calc_dimensions__, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} __calc_dimensions__ (@var{axes})\n\ -Internal function. Determine the number of dimensions in a graphics\n\ -object, whether 2 or 3.\n\ +Internal function.\n\ +\n\ +Determine the number of dimensions in a graphics object, either 2 or 3.\n\ @end deftypefn") { gh_manager::auto_lock guard; @@ -11163,12 +11168,16 @@ @deftypefn {Built-in Function} {} drawnow ()\n\ @deftypefnx {Built-in Function} {} drawnow (\"expose\")\n\ @deftypefnx {Built-in Function} {} drawnow (@var{term}, @var{file}, @var{mono}, @var{debug_file})\n\ -Update figure windows and their children. The event queue is flushed and\n\ -any callbacks generated are executed. With the optional argument\n\ -@qcode{\"expose\"}, only graphic objects are updated and no other events or\n\ -callbacks are processed.\n\ +Update figure windows and their children.\n\ +\n\ +The event queue is flushed and any callbacks generated are executed.\n\ +\n\ +With the optional argument @qcode{\"expose\"}, only graphic objects are\n\ +updated and no other events or callbacks are processed.\n\ +\n\ The third calling form of @code{drawnow} is for debugging and is\n\ undocumented.\n\ +@seealso{refresh}\n\ @end deftypefn") { static int drawnow_executing = 0; @@ -11351,9 +11360,10 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} addlistener (@var{h}, @var{prop}, @var{fcn})\n\ Register @var{fcn} as listener for the property @var{prop} of the graphics\n\ -object @var{h}. Property listeners are executed (in order of registration)\n\ -when the property is set. The new value is already available when the\n\ -listeners are executed.\n\ +object @var{h}.\n\ +\n\ +Property listeners are executed (in order of registration) when the property\n\ +is set. The new value is already available when the listeners are executed.\n\ \n\ @var{prop} must be a string naming a valid property in @var{h}.\n\ \n\ @@ -11430,9 +11440,10 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} dellistener (@var{h}, @var{prop}, @var{fcn})\n\ Remove the registration of @var{fcn} as a listener for the property\n\ -@var{prop} of the graphics object @var{h}. The function @var{fcn} must\n\ -be the same variable (not just the same value), as was passed to the\n\ -original call to @code{addlistener}.\n\ +@var{prop} of the graphics object @var{h}.\n\ +\n\ +The function @var{fcn} must be the same variable (not just the same value),\n\ +as was passed to the original call to @code{addlistener}.\n\ \n\ If @var{fcn} is not defined then all listener functions of @var{prop}\n\ are removed.\n\ @@ -11511,6 +11522,7 @@ @deftypefn {Built-in Function} {} addproperty (@var{name}, @var{h}, @var{type})\n\ @deftypefnx {Built-in Function} {} addproperty (@var{name}, @var{h}, @var{type}, @var{arg}, @dots{})\n\ Create a new property named @var{name} in graphics object @var{h}.\n\ +\n\ @var{type} determines the type of the property to create. @var{args}\n\ usually contains the default value of the property, but additional\n\ arguments might be given, depending on the type of the property.\n\ @@ -11805,10 +11817,10 @@ Suspend the execution of the current program until a condition is\n\ satisfied on the graphics handle @var{h}.\n\ \n\ -While the program is suspended graphics events are still being processed\n\ -normally, allowing callbacks to modify the state of graphics objects. This\n\ -function is reentrant and can be called from a callback, while another\n\ -@code{waitfor} call is pending at the top-level.\n\ +While the program is suspended graphics events are still processed normally,\n\ +allowing callbacks to modify the state of graphics objects. This function\n\ +is reentrant and can be called from a callback, while another @code{waitfor}\n\ +call is pending at the top-level.\n\ \n\ In the first form, program execution is suspended until the graphics object\n\ @var{h} is destroyed. If the graphics handle is invalid, the function\n\