diff scripts/strings/substr.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/substr.m	Fri Nov 19 05:15:27 1999 +0000
+++ b/scripts/strings/substr.m	Fri Nov 19 21:19:44 1999 +0000
@@ -17,12 +17,28 @@
 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 ## 02111-1307, USA.
 
-## usage:  substr (s, offset, len)
-##
-## Returns the substring of S of length LEN starting at index OFFSET.
+## -*- texinfo -*-
+## @deftypefn {Function File} {} substr (@var{s}, @var{beg}, @var{len})
+## Return the substring of @var{s} which starts at character number
+## @var{beg} and is @var{len} characters long.
+## 
 ## If OFFSET is negative, extraction starts that far from the end of
 ## the string.  If LEN is omitted, the substring extends to the end
 ## of S.
+## 
+##   For example,
+## 
+## @example
+## substr ("This is a test string", 6, 9)
+##      @result{} "is a test"
+## @end example
+## 
+## @quotation
+## @strong{Note:}
+## This function is patterned after AWK.  You can get the same result by
+## @code{@var{s} (@var{beg} : (@var{beg} + @var{len} - 1))}.  
+## @end quotation
+## @end deftypefn
 
 ## Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>
 ## Adapted-By: jwe