Changeset 163 for trunk/SRC/Textoidl/strcnt.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Textoidl/strcnt.pro (modified) (2 diffs)

trunk/SRC/Textoidl/strcnt.pro

@@ +1 @@
+;+
+; @file_comments
+; Count number of occurrences of a substring in a string.
 ;
-;+
-; NAME:
-;       STRCNT
-; PURPOSE:
-;       Count number of occurrences of a substring in a string.
-; CATEGORY:
-;       text/strings
-; CALLING SEQUENCE:
-;       num = strcnt(strn, substring, [pos])
-; INPUTS:
-;       string    -- The string in which to count occurences.     in
-;       substring -- The substring to count occurrences of.       in
-;       pos       -- the position at which to begin the search.   [in]
-;                    If not supplied, start at beginning of
-;                    string.
-; KEYWORD PARAMETERS:
-;       /HELP     -- Print useful message and return.
-; OUTPUTS:
-;       num       -- Number of occurances of substring in string. out
-; COMMON BLOCKS:
-; SIDE EFFECTS:
-; NOTES:
-;       Overlapping occurances are not counted separately.  For
-;       example, counting occurances of 'bb' in 'blah bbb' returns one
-;       occurance. 
-; EXAMPLE:
-; MODIFICATION HISTORY:
-;       $Id: strcnt.pro,v 1.3 1996/06/14 20:00:27 mcraig Exp $
+; @categories
+; Text, String
+;
+; @param STRN {in}{required}{type=string}
+; The string in which to count occurences.
+;
+; @param SUBSTRN {in}{required}{type=string}
+; The substring to count occurrences of.
+;
+; @param STARTPOS {in}{required}
+; The position at which to begin the search.
+; If not supplied, start at beginning of string.
+;
+; @keyword HELP
+; Print useful message and return.
+;
+; @returns
+; Number of occurances of substring in string.
+;
+; @restrictions
+; Overlapping occurances are not counted separately.  For
+; example, counting occurances of 'bb' in 'blah bbb' returns one
+; occurance. 
+;
+; @history
 ;       $Log: strcnt.pro,v $
 ;       Revision 1.3  1996/06/14 20:00:27  mcraig
@@ -39 +39 @@
 ;       Initial revision
 ;
-; RELEASE:
-;       $Name: Rel_2_1_2 $
-;
-; COPYRIGHT:
 ;  Copyright (C) 1996 The Regents of the University of California, All
 ;  Rights Reserved.  Written by Matthew W. Craig.
 ;  See the file COPYRIGHT for restrictions on distrubting this code.
 ;  This code comes with absolutely NO warranty; see DISCLAIMER for details.
+;
+; @version
+; $Id$
 ;-
-FUNCTION Strcnt, strn, substrn, startpos, $
+FUNCTION strcnt, strn, substrn, startpos, $
                  HELP=Help
 ;