octave-antonio: scripts/path/matlabroot.m annotate

annotate scripts/path/matlabroot.m @ 20160:03b9d17a2d95 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 15:36:23 -0700
parents	4197fc428c7d
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19335 diff changeset	1 ## Copyright (C) 2008-2015 Ben Abbott
7388 0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	2 ##
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	4 ##
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	8 ## your option) any later version.
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	9 ##
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	14 ##
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	18
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
12208 9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	20 ## @deftypefn {Function File} {} matlabroot ()
9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	21 ## Return the name of the top-level Octave installation directory.
9611014e7cf1 Add function compare_versions to documentation. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	22 ##
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	23 ## This is an alias for the function @w{@code{OCTAVE_HOME}} provided for
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## compatibility.
7388 0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	25 ## @seealso{OCTAVE_HOME}
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	26 ## @end deftypefn
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	27
14216 b3730ed107a6 Clean up scripts in path/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	28 function retval = matlabroot ()
7388 0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	29
14216 b3730ed107a6 Clean up scripts in path/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	30 retval = OCTAVE_HOME;
7388 0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	31
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	32 endfunction
0e1ccfe1bf91 [project @ 2008-01-16 06:31:23 by jwe] jwe parents: diff changeset	33
14216 b3730ed107a6 Clean up scripts in path/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	34
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14216 diff changeset	35 %!assert (matlabroot (), OCTAVE_HOME ())
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14216 diff changeset	36

Mercurial > octave-antonio

annotate scripts/path/matlabroot.m @ 20160:03b9d17a2d95 stable