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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/STRING/strright.pro (modified) (1 diff)

trunk/SRC/ToBeReviewed/STRING/strright.pro

@@ -1 @@
-; $Id$
 ;-------------------------------------------------------------
 ;+
-; NAME:
-;        STRRIGHT
 ;
-; PURPOSE:
-;        return right subportion from a string
+; @file_comments
+; return right subportion from a string
 ;
-; CATEGORY:
-;        string handling 
+; @categories
+; string handling 
+; 
+; @param S {in}{required}
+; the string to be searched
 ;
-; CALLING SEQUENCE:
-;        res = STRRIGHT(string [,nlast])
+; @param LASTN {in}{required}
+; the number of characters to be returned. Default
+; is 1. If NLAST is ge strlen(STRING), the complete string
+; is returned.
 ;
-; INPUTS:
-;        STRING --> the string to be searched
+; @returns
+; The portion of LASTN characters of S counted from the back.
 ;
-;        NLAST --> the number of characters to be returned. Default
-;           is 1. If NLAST is ge strlen(STRING), the complete string
-;           is returned.
+; @examples
+; if (strright(path) ne '/') then path = path + '/'
 ;
-; KEYWORD PARAMETERS:
+; @history
+;        mgs, 19 Nov 1997: VERSION 1.00
 ;
-; OUTPUTS:
-;        The portion of NLAST characters of STRING counted from the back.
-;
-; SUBROUTINES:
-;
-; REQUIREMENTS:
-;
-; NOTES:
-;
-; EXAMPLE:
-;        if (strright(path) ne '/') then path = path + '/'
-;
-; MODIFICATION HISTORY:
-;        mgs, 19 Nov 1997: VERSION 1.00
+; @version
+; $Id$
 ;
 ;-