Mercurial > hg > octave-nkf
annotate scripts/gui/private/__get_funcname__.m @ 20383: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 | 75d1c4096ba7 |
children |
rev | line source |
---|---|
19898
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19163
diff
changeset
|
1 ## Copyright (C) 2014-2015 Andreas Weber |
19163
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
2 ## |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
3 ## This file is part of Octave. |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
4 ## |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
5 ## Octave is free software; you can redistribute it and/or modify it |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
6 ## under the terms of the GNU General Public License as published by |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
8 ## your option) any later version. |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
9 ## |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
10 ## Octave is distributed in the hope that it will be useful, but |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
13 ## General Public License for more details. |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
14 ## |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
15 ## You should have received a copy of the GNU General Public License |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
16 ## along with Octave; see the file COPYING. If not, see |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
17 ## <http://www.gnu.org/licenses/>. |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
18 |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
19 ## -*- texinfo -*- |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
20 ## @deftypefn {Function File} {@var{funcname} =} __get_funcname__ (@var{basename}) |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
21 ## Internal function. |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
22 ## |
20383
777f26aa8e3e
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20090
diff
changeset
|
23 ## Build function name for the current graphics toolkit according to the schema |
19163
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
24 ## __[basename]_[graphics_toolkit]__, use fltk as default. |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
25 ## @end deftypefn |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
26 |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
27 ## Author: Andreas Weber |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
28 |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
29 function funcname = __get_funcname__ (basename) |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
30 |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
31 if (! __octave_link_enabled__ ()) |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
32 tk = graphics_toolkit (); |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
33 funcname = strcat ("__", basename, "_", tk, "__"); |
20038
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
34 if (numel (tk) > 0 && ! strcmp (tk, "fltk") |
20090
75d1c4096ba7
gui/private/__get_funcname__.m: fix syntax error (extra ")" from 9fc020886ae9)
Carnë Draug <carandraug@octave.org>
parents:
20038
diff
changeset
|
35 && ! __is_function__ (funcname)) |
20038
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
36 warning ("%s: no implementation for toolkit '%s', using 'fltk' instead", |
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
37 basename, tk); |
19163
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
38 endif |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
39 funcname = strcat ("__", basename, "_fltk__"); |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
40 else |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
41 funcname = ""; |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
42 endif |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
43 |
f084aab05cd9
Move checks for graphics_toolkit GUI functions to own script.
Andreas Weber <andy.weber.aw@gmail.com>
parents:
diff
changeset
|
44 endfunction |