view scripts/miscellaneous/version.m @ 12288:f07e6b4d34c7 release-3-4-x

Add function compare_versions to documentation. Update docstrings for surrounding functions in manual.
author Rik <octave@nomad.inbox5.com>
date Sat, 29 Jan 2011 16:54:14 -0800
parents fd0a3ac60b0e
children 8c0bf79b5c6a
line wrap: on
line source

## Copyright (C) 1994-2011 John W. Eaton
##
## 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} {} version ()
## Return the version number of Octave, as a string.
##
## This is an alias for the function @code{OCTAVE_VERSION} provided for
## compatability
## @seealso{OCTAVE_VERSION}.
## @end deftypefn

## Author: jwe

function vs = version ()

  if (nargin != 0)
    warning ("version: ignoring extra arguments");
  endif

  vs = OCTAVE_VERSION;

endfunction

%!assert(ischar (version ()) && strcmp (version (), OCTAVE_VERSION));

%!warning version (1);