Changeset 163 for trunk/SRC/ToBeReviewed/STRING/str_size.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/ToBeReviewed/STRING/str_size.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/STRING/str_size.pro

@@ -3 +3 @@
 ; @file_comments
 ; The purpose of this function is to return the proper
-; character size to make a specified string a specifed
+; character size to make a specified string a specified
 ; width in a window. The width is specified in normalized
 ; coordinates. The function is extremely useful for sizing
@@ -12 +12 @@
 ;
 ; @param STRING {in}{required}
-; This is the string that you want to make a specifed
+; This is the string that you want to make a specified
 ; target size or width.
 ;
-; @param TARGETWIDTH {in}{optional}
+; @param TARGETWIDTH {in}{optional}{default=0.25}
 ; This is the target width of the string in normalized
 ; coordinates in the current graphics window. The character
 ; size of the string (returned as thisCharSize) will be
 ; calculated to get the string width as close as possible to
-; the target width. The default is 0.25.
+; the target width.
 ;
-; @keyword INITSIZE  
+; @keyword INITSIZE {default=1.0}  
 ; This is the initial size of the string. Default is 1.0.
 ;
-; @keyword STEP
+; @keyword STEP{default=0.05}
 ; This is the amount the string size will change in each step
-; of the interative process of calculating the string size.
-; The default value is 0.05.
+; of the interactive process of calculating the string size.
 ;
 ; @returns 
@@ -53 +52 @@
 ;-
 
-FUNCTION STR_SIZE, string, targetWidth, INITSIZE=initsize, STEP=step
+FUNCTION str_size, string, targetWidth, INITSIZE=initsize, STEP=step
 ;
   compile_opt idl2, strictarrsubs