Changeset 142 for trunk/SRC/ToBeReviewed/STRING/strrepl.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/STRING/strrepl.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/STRING/strrepl.pro

@@ -1 @@
-; $Id$
 ;-------------------------------------------------------------
 ;+
-; NAME:
-;        STRREPL (function)
 ;
-; PURPOSE:
-;        replace one (or more) character(s)/string(s) in a string
+; @file_comments 
+; replace one (or more) character(s)/string(s) in a string
 ;
-; CATEGORY:
-;        string routines
+; @categories
+; string routines
 ;
-; CALLING SEQUENCE:
-;        Result = STRREPL(str, index, rchar)
+; @param STR {in}{required}
+; the string to be changed
 ;
-; INPUTS:
-;        STR -> the string to be changed
+; @param RCHAR {in}{required}
+; replacement character/string
 ;
-;        INDEX -> position of the character(s) to be replaced or a
-;        string to be changed in STR.
+; @returns
+; another string
 ;
-;        RCHAR -> replacement character/string
+; @restrictions 
+; Known shortcoming: if index is an array, it must contain all
+; valid elements (only the first entry is checked).
 ;
-; KEYWORD PARAMETERS: none
-;
-;
-; OUTPUTS:
-;        another string
-;
-; SUBROUTINES:
-;
-; REQUIREMENTS:
-;
-; NOTES:
-;        Known shortcoming: if index is an array, it must contain all
-;        valid elements (only the first entry is checked).
-;
-; EXAMPLE:
+; @examples
 ;        ; Convert one letter into upper case
 ;
@@ -58 +43 @@
 ;       abcabcabc
 ;
-; MODIFICATION HISTORY:
+; @history
 ;        mgs, 02 Jun 1998: VERSION 1.00
 ;        sebastien Masson (smlod@ipsl.jussieu.fr)
+;
+; @version
+; $Id$
 ;
 ;-