Changeset 150 for trunk/SRC/ToBeReviewed/STRUCTURE/struct2string.pro

Timestamp:

08/09/06 12:12:54 (18 years ago)

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/STRUCTURE/struct2string.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/STRUCTURE/struct2string.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:struct2string
+; 
+; @file_comments
+; Convert a structure to an "executable string"
 ;
-; PURPOSE:convert a structure to an "executable string"
+; @categories
+; utilities
+; 
+; @param STRUCT {in}{required}
+; A structure
 ;
-; CATEGORY:bidouille
+; @keyword MAX_STRUCT_LENGTH
+; The maximum length of the structure
+; permetted to convert the structure to string. Default is
+; 10000l.
 ;
-; CALLING SEQUENCE:sting=struct2string(struct)
-; 
-; INPUTS:struct: a structure
+; @keyword DIRECT2STRING
+; To get a string instead an "executable string"
 ;
-; KEYWORD PARAMETERS:
+; @keyword CUT_IN_STRING
+; Try it
 ;
-;      MAX_STRUCT_LENGTH : the maximum length of the structure
-;      permetted to convert the structure to string. Default is
-;      10000l.
+; @restrictions
+; Use tostr.pro, cf this function header!
 ;
-;      /DIRECT2STRING: to get a string instead an "executable string"
-;
-;      /CUT_IN_STRING: try it
-;
-; OUTPUTS:
-;
-; SIDE EFFECTS:use tostr.pro, cf this function header!
-;
-; RESTRICTIONS:use tostr.pro, cf this function header!
-;
-; EXAMPLE:
+; @examples
 ;
 ;      IDL> print, struct2string(!d)
@@ -38 +36 @@
 ;      ,[0,0],'ZOOM',[1,1])
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      2000 07 03
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------