annotate scripts/miscellaneous/ismac.m @ 11431:0d9640d755b1

Improve docstrings for all isXXX functions. Use 'return true' rather than 'return 1'. Improve the cross-referencing through seealso links.
author Rik <octave@nomad.inbox5.com>
date Fri, 31 Dec 2010 13:20:44 -0800
parents 93c65f2a5668
children fd0a3ac60b0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7010
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2007 Thomas Treichl
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
2 ##
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
4 ##
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7010
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7010
diff changeset
8 ## your option) any later version.
7010
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
9 ##
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
14 ##
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7010
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7010
diff changeset
17 ## <http://www.gnu.org/licenses/>.
7010
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
18
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} ismac ()
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 7016
diff changeset
21 ## Return true if Octave is running on a Mac OS X system and false otherwise.
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 7016
diff changeset
22 ## @seealso{isunix, ispc}
7010
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
23 ## @end deftypefn
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
24
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
25 function retval = ismac ()
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
26
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
27 if (nargin == 0)
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
28 retval = octave_config_info ("mac");
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
29 else
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
30 print_usage ();
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
31 endif
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
32
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
33 endfunction
f7d2f54008f5 [project @ 2007-10-11 17:50:34 by jwe]
jwe
parents:
diff changeset
34