Mercurial > hg > octave-terminal
changeset 12215:4ae2a74ed04c
Add fltk_gui_mode, fltk_mouse_wheel_zoom to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sat, 29 Jan 2011 22:31:31 -0800 |
parents | 0ce4a9cd6a7f |
children | becaa4b96728 |
files | doc/ChangeLog doc/interpreter/octave.texi doc/interpreter/plot.txi scripts/ChangeLog scripts/plot/gnuplot_binary.in src/ChangeLog src/DLD-FUNCTIONS/__init_fltk__.cc src/graphics.cc |
diffstat | 8 files changed, 36 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2011-01-29 Rik <octave@nomad.inbox5.com> + + * interpreter/octave.texi: Add new subsection on FLTK interaction. + * interpreter/plot.txi: Add fltk_gui_mode, fltk_mouse_wheel_zoom + functions to documentation. + 2011-01-29 Rik <octave@nomad.inbox5.com> * interpreter/arith.txi: Add accumdim function to documentation.
--- a/doc/interpreter/octave.texi +++ b/doc/interpreter/octave.texi @@ -561,6 +561,7 @@ Graphics Toolkits * Interaction with gnuplot:: +* Interaction with FLTK:: Matrix Manipulation
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -3223,6 +3223,7 @@ @menu * Interaction with gnuplot:: +* Interaction with FLTK:: @end menu @node Interaction with gnuplot @@ -3230,3 +3231,11 @@ @cindex gnuplot interaction @DOCSTRING(gnuplot_binary) + +@node Interaction with FLTK +@subsubsection Interaction with FLTK + +@DOCSTRING(fltk_gui_mode) + +@DOCSTRING(fltk_mouse_wheel_zoom) +
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,7 @@ +2010-01-29 Rik <octave@nomad.inbox5.com> + + * plot/gnuplot_binary.in: Improve docstring + 2010-01-29 Rik <octave@nomad.inbox5.com> * general/accumarray.m: Add seealso reference to accumdim.
--- a/scripts/plot/gnuplot_binary.in +++ b/scripts/plot/gnuplot_binary.in @@ -20,9 +20,10 @@ ## @deftypefn {Loadable Function} {[@var{prog}, @var{args}] =} gnuplot_binary () ## @deftypefnx {Loadable Function} {[@var{old_prog}, @var{old_args}] =} gnuplot_binary (@var{new_prog}, @var{arg1}, @dots{}) ## Query or set the name of the program invoked by the plot command -## and any arguments to pass to it. Previous arguments are returned -## as a cell array. -## The default value @code{\"gnuplot\"}. @xref{Installation}. +## when the graphics toolkit is set to "gnuplot". Additional arguments to +## pass to the external plotting program may also be given. +## The default value is @code{"gnuplot"} without additional arguments. +## @xref{Installation}. ## @end deftypefn ## Author: jwe
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,10 @@ +2011-01-29 Rik <octave@nomad.inbox5.com> + + * DLD-FUNCTIONS/__init_fltk__.cc (fltk_gui_mode, fltk_mouse_wheel_zoom): + Improve docstrings. + + * graphics.cc (available_graphics_toolkits): Fix typo in docstring. + 2011-01-29 Rik <octave@nomad.inbox5.com> * syscalls.cc (S_ISSOCK, S_ISCHR): Improve docstrings
--- a/src/DLD-FUNCTIONS/__init_fltk__.cc +++ b/src/DLD-FUNCTIONS/__init_fltk__.cc @@ -1970,7 +1970,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{speed} =} fltk_mouse_wheel_zoom ()\n\ @deftypefnx {Built-in Function} {} fltk_mouse_wheel_zoom (@var{speed})\n\ -Query or set the mouse wheel zoom factor in the fltk graphics toolkit.\n\ +Query or set the mouse wheel zoom factor in the FLTK graphics toolkit.\n\ +@seealso{fltk_gui_mode}\n\ @end deftypefn") { octave_value retval = wheel_zoom_speed; @@ -2002,6 +2003,7 @@ @item 'none'\n\ Mouse inputs have no effect.\n\ @end table\n\ +@seealso{fltk_mouse_wheel_zoom}\n\ @end deftypefn") { caseless_str mode_str; @@ -2036,7 +2038,7 @@ } if (failed) - error ("MODE must be one of the strings: \"2D\", \"3D\", or \"None\""); + error ("MODE must be one of the strings: \"2D\", \"3D\", or \"none\""); return octave_value(mode_str);
--- a/src/graphics.cc +++ b/src/graphics.cc @@ -6763,7 +6763,7 @@ DEFUN (available_graphics_toolkits, , , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} available_graphiscs_toolkits ()\n\ +@deftypefn {Built-in Function} {} available_graphics_toolkits ()\n\ Return a cell array of registered graphics toolkits.\n\ @end deftypefn") {