view scripts/general/display.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 ebf6f6a0f9a7
children 17ce09c3d030
line wrap: on
line source

## Copyright (C) 2008 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} {} display (@var{a})
## Display the contents of an object.  If @var{a} is an object of the
## class "myclass", then @code{display} is called in a case like
##
## @example
## myclass (@dots{})
## @end example
##
## @noindent
## where Octave is requried to display the contents of a variable of the
## type "myclass".
##
## @seealso{class, subsref, subsasgn}
## @end deftypefn

function idx = display (a)
  error ("display: not defined for class \"%s\"", class(a));
endfunction