diff scripts/strings/str2mat.m @ 3361:4f40efa995c1

[project @ 1999-11-19 21:19:37 by jwe]
author jwe
date Fri, 19 Nov 1999 21:19:44 +0000
parents 390d5e396682
children f8dde1807dee
line wrap: on
line diff
--- a/scripts/strings/str2mat.m
+++ b/scripts/strings/str2mat.m
@@ -17,10 +17,17 @@
 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 ## 02111-1307, USA.
 
-## usage:  m = str2mat (s1, ...)
-##
-## Forms the matrix M containing the strings S1, ... as its rows.
-## Each string is padded with blanks in order to form a valid matrix.
+## -*- texinfo -*-
+## @deftypefn {Function File} {} str2mat (@var{s_1}, @dots{}, @var{s_n})
+## Return a matrix containing the strings @var{s_1}, @dots{}, @var{s_n} as
+## its rows.  Each string is padded with blanks in order to form a valid
+## matrix.
+## 
+## @strong{Note:}
+## This function is modelled after @sc{Matlab}.  In Octave, you can create
+## a matrix of strings by @code{[@var{s_1}; @dots{}; @var{s_n}]} even if
+## the strings are not all the same length.
+## @end deftypefn
 
 ## Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>
 ## Adapted-By: jwe