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

[project @ 1999-11-19 21:19:37 by jwe]
author jwe
date Fri, 19 Nov 1999 21:19:44 +0000
parents 2e74d8aa1a20
children f8dde1807dee
line wrap: on
line diff
--- a/scripts/strings/index.m
+++ b/scripts/strings/index.m
@@ -17,12 +17,18 @@
 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 ## 02111-1307, USA.
 
-## usage:  index (s, t)
-##
-## Returns the position of the first occurence of the string T in the
-## string S or 0 if no occurence is found.
-##
-## NOTE: this function does not work for arrays of strings.
+## -*- texinfo -*-
+## @deftypefn {Function File} {} index (@var{s}, @var{t})
+## Return the position of the first occurrence of the string @var{t} in the
+## string @var{s}, or 0 if no occurrence is found.  For example,
+## 
+## @example
+## index ("Teststring", "t")
+##      @result{} 4
+## @end example
+## 
+## @strong{Note:}  This function does not work for arrays of strings.
+## @end deftypefn
 
 ## Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>
 ## Adapted-By: jwe