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

[project @ 1999-11-19 21:19:37 by jwe]
author jwe
date Fri, 19 Nov 1999 21:19:44 +0000
parents c9f70d39255f
children f8dde1807dee
line wrap: on
line diff
--- a/scripts/strings/findstr.m	Fri Nov 19 05:15:27 1999 +0000
+++ b/scripts/strings/findstr.m	Fri Nov 19 21:19:44 1999 +0000
@@ -17,18 +17,20 @@
 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 ## 02111-1307, USA.
 
-## usage: findstr (s, t [, overlap])
-##
-## Returns the vector of all positions in the longer of the two strings
-## S and T where an occurence of the shorter of the two starts.
-##
-## If the optional argument OVERLAP is nonzero, the returned vector
-## can include overlapping positions (this is the default).
-##
-## For example,
-##
-##   findstr ("abababa", "aba")     =>  [1, 3, 5]
-##   findstr ("abababa", "aba", 0)  =>  [1, 5]
+## -*- texinfo -*-
+## @deftypefn {Function File} {} findstr (@var{s}, @var{t}, @var{overlap})
+## Return the vector of all positions in the longer of the two strings
+## @var{s} and @var{t} where an occurrence of the shorter of the two starts.
+## If the optional argument @var{overlap} is nonzero, the returned vector
+## can include overlapping positions (this is the default).  For example,
+## 
+## @example
+## findstr ("ababab", "a")
+##      @result{} [ 1, 3, 5 ]
+## findstr ("abababa", "aba", 0)
+##      @result{} [ 1, 5 ]
+## @end example
+## @end deftypefn
 
 ## Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>
 ## Adapted-By: jwe