Mercurial > octave-nkf
view scripts/plot/util/colstyle.m @ 20208:777f26aa8e3e stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed plot/ and gui/ in scripts directory.
* scripts/gui/errordlg.m, scripts/gui/helpdlg.m, scripts/gui/inputdlg.m,
scripts/gui/listdlg.m, scripts/gui/msgbox.m,
scripts/gui/private/__get_funcname__.m,
scripts/gui/private/__uiobject_split_args__.m, scripts/gui/questdlg.m,
scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uiwait.m,
scripts/gui/waitbar.m, scripts/gui/warndlg.m,
scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m,
scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m,
scripts/plot/appearance/datetick.m, scripts/plot/appearance/hidden.m,
scripts/plot/appearance/legend.m, scripts/plot/appearance/xlim.m,
scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlim.m,
scripts/plot/draw/area.m, scripts/plot/draw/comet.m,
scripts/plot/draw/comet3.m, scripts/plot/draw/contour.m,
scripts/plot/draw/contourf.m, scripts/plot/draw/isocolors.m,
scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m,
scripts/plot/draw/plotmatrix.m, scripts/plot/draw/quiver.m,
scripts/plot/draw/quiver3.m, scripts/plot/draw/ribbon.m,
scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogyerr.m,
scripts/plot/draw/sphere.m, scripts/plot/draw/surfl.m,
scripts/plot/draw/tetramesh.m, scripts/plot/util/allchild.m,
scripts/plot/util/ancestor.m, scripts/plot/util/axes.m,
scripts/plot/util/colstyle.m, scripts/plot/util/frame2im.m,
scripts/plot/util/gnuplot_binary.in, scripts/plot/util/hgsave.m,
scripts/plot/util/im2frame.m, scripts/plot/util/isaxes.m,
scripts/plot/util/isfigure.m, scripts/plot/util/linkaxes.m,
scripts/plot/util/ndgrid.m, scripts/plot/util/pan.m, scripts/plot/util/print.m,
scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m,
scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m,
scripts/plot/util/saveas.m, scripts/plot/util/struct2hdl.m,
scripts/plot/util/subplot.m, scripts/plot/util/zoom.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 09 May 2015 22:50:09 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2012-2015 David Bateman ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{style}, @var{color}, @var{marker}, @var{msg}] =} colstyle (@var{linespec}) ## Parse @var{linespec} and return the line style, color, and markers given. ## ## In the case of an error, the string @var{msg} will return the text of the ## error. ## @end deftypefn function [l, c, m, msg] = colstyle (style) if (nargin != 1) print_usage (); endif if (! ischar (style)) error ("colstyle: STYLE must be a string"); endif try opt = __pltopt__ ("colstyle", style); l = opt.linestyle; switch (opt.color) case [0 0 0] c = "k"; case [1 0 0] c = "r"; case [0 1 0] c = "g"; case [0 0 1] c = "b"; case [1 1 0] c = "y"; case [1 0 1] c = "m"; case [0 1 1] c = "c"; case [0 1 1] c = "w"; otherwise c = opt.color; endswitch m = opt.marker; msg = []; catch l = c = m = []; msg = lasterr (); end_try_catch endfunction %!test %! [l, c, m, msg] = colstyle ("r:x"); %! assert (isempty (msg)); %! assert (l, ":"); %! assert (c, "r"); %! assert (m, "x"); %!test %! [l, c, m, msg] = colstyle ("."); %! assert (isempty (msg)); %! assert (l, "none"); %! assert (c, []); %! assert (m, "."); %!test %! [l, c, m, msg] = colstyle ("~"); %! assert (msg, "colstyle: unrecognized format character: '~'"); ## Test input validation %!error colstyle () %!error colstyle (1, 2) %!error <STYLE must be a string> colstyle (1.5)