octave-antonio: scripts/strings/blanks.m annotate

annotate scripts/strings/blanks.m @ 20164:df437a52bcaf stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Mon, 04 May 2015 14:22:02 -0700
parents	9fc020886ae9
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1996-2015 Kurt Hornik
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	2 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 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: 6387 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: 6387 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 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: 6387 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: 6387 diff changeset	17 ## <http://www.gnu.org/licenses/>.
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	18
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3081 diff changeset	19 ## -- texinfo --
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3081 diff changeset	20 ## @deftypefn {Function File} {} blanks (@var{n})
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	21 ## Return a string of @var{n} blanks.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	22 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ## For example:
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7411 diff changeset	24 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7411 diff changeset	25 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7411 diff changeset	26 ## @group
13179 8c4a2c2cc2b0 blanks.m: Validate input is non-negative. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	27 ## blanks (10);
14402 cbcaf5602469 doc: Make spacing nicer for Strings chapter of manual. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	28 ## whos ans
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7411 diff changeset	29 ## @result{}
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7411 diff changeset	30 ## Attr Name Size Bytes Class
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	31 ## ==== ==== ==== ===== =====
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7411 diff changeset	32 ## ans 1x10 10 char
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7411 diff changeset	33 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7411 diff changeset	34 ## @end example
6138 c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6046 diff changeset	35 ## @seealso{repmat}
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3081 diff changeset	36 ## @end deftypefn
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	37
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	38 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
2355 c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe] jwe parents: 2326 diff changeset	39 ## Adapted-By: jwe
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	40
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	41 function s = blanks (n)
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	42
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	43 if (nargin != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5443 diff changeset	44 print_usage ();
13179 8c4a2c2cc2b0 blanks.m: Validate input is non-negative. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	45 elseif (! (isscalar (n) && n == fix (n) && n >= 0))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	46 error ("blanks: N must be a non-negative integer");
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	47 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	48
6387 24666a9192f2 [project @ 2007-03-07 08:43:03 by jwe] jwe parents: 6138 diff changeset	49 ## If 1:n is empty, the following expression will create an empty
24666a9192f2 [project @ 2007-03-07 08:43:03 by jwe] jwe parents: 6138 diff changeset	50 ## character string. Otherwise, it will create a row vector.
24666a9192f2 [project @ 2007-03-07 08:43:03 by jwe] jwe parents: 6138 diff changeset	51 s(1:n) = " ";
6138 c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6046 diff changeset	52
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	53 endfunction
6138 c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6046 diff changeset	54
13179 8c4a2c2cc2b0 blanks.m: Validate input is non-negative. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	55
6138 c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6046 diff changeset	56 ## There really isn't that much to test here
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	57 %!assert (blanks (0), "")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	58 %!assert (blanks (5), " ")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	59 %!assert (blanks (10), " ")
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	60
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	61 ## Test input validation
13179 8c4a2c2cc2b0 blanks.m: Validate input is non-negative. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	62 %!error blanks ()
8c4a2c2cc2b0 blanks.m: Validate input is non-negative. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	63 %!error blanks (1, 2)
8c4a2c2cc2b0 blanks.m: Validate input is non-negative. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	64 %!error blanks (ones (2))
8c4a2c2cc2b0 blanks.m: Validate input is non-negative. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	65 %!error blanks (2.1)
8c4a2c2cc2b0 blanks.m: Validate input is non-negative. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	66 %!error blanks (-2)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	67

Mercurial > octave-antonio

annotate scripts/strings/blanks.m @ 20164:df437a52bcaf stable