view scripts/plot/gcbf.m @ 9051:1bf0ce0930be

Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents dbd0c77e575e
children 16f53d29049f
line wrap: on
line source

## Copyright (C) 2008 Michael Goffioul
##
## 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{fig} =} gcbf ()
## Return a handle to the figure containing the object whose callback
## is currently executing.  If no callback is executing, this function
## returns the empty matrix.  The handle returned by this function is
## the same as the second output argument of gcbo.
##
##@seealso{gcf, gca, gcbo}
##@end deftypefn

function fig = gcbf ()

  [dummy, fig] = gcbo ();

endfunction