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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/STRING/string2struct.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/STRING/string2struct.pro

@@ -11 +11 @@
 
 ;+
-; NAME:
-;       stringToStructure
 ;
-; PURPOSE:
-;       Takes an input string set up as keywords and returns an anonymous structure.
-;               This is particularly useful for taking keywords entered by a user in a text
-;               field and passing then to other routines.
+; @file_comments
+; Takes an input string set up as keywords and returns an anonymous structure.
+; This is particularly useful for taking keywords entered by a user in a text
+; field and passing then to other routines.
 ;
-; CATEGORY:
-;       Utility
+; @categories
+; Utility
 ;
-; CALLING SEQUENCE:
-;       extra=stringToStructure('xrange=[0,10],linestyle=2')
-;       plot,findgen(100),_extra=extra
+; @param STRVAL {IN}{REQUIRED}
+; String set up as keywords. Keywords require a little special treatment. Such as
+; plot,findgen(100),_extra=stringToStructure('title="testing"')
 ;
-; INPUTS:
-;       String set up as keywords. Keywords require a little special treatment. Such as
-;       plot,findgen(100),_extra=stringToStructure('title="testing"')
+; @RETURNS 
+; This function returns the string as an anonymous structure. If an
+; error was found then this function returns a structure with a null field.
 ;
-; KEYWORD PARAMETERS:
-;
-;       None
-;
-; OUTPUTS:
-;       This function returns the string as an anonymous structure. If an
-;       error was found then this function returns a structure with a null field.
-;
-; COMMON BLOCKS:
-;       None.
-;
-; EXAMPLE:
+; @examples
 ;       The code below creates a widget that uses this routine.
 ;       pro tPlot,event
@@ -62 +49 @@
 ;       end
 ;
-; MODIFICATION HISTORY:
+; @history
 ;       Written by:
 ;       RLK, Ronn Kling Consulting.
@@ -68 +55 @@
 ;       www.rlkling.com
 ;               May, 1999
+;
+; @version
+; $Id$
+;
 ;-