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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (3a)

File:

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

trunk/SRC/ToBeReviewed/STRUCTURE/mixstru.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: mixstru
 ;
-; PURPOSE: concatene 2 structures ensemble. La difference avec
-; CREATE_STRUCT etant que si les 2 stuctures ont les memes noms
-; d''elements alors mixstru ne plante pas mais choisit pour valeur de
-; l''element commun celle specifiee par la premiere structure.
+; @file_comments
+; Concatenate 2 structures together. The difference with CREATE_STRUCT 
+; is  that if the 2 structure have same elements's name, then mixstru 
+; do not break down but choose for the common element the value 
+; specified by the first structure.
 ;
-; CATEGORY: structure
+; @categories
+; structure
+; 
+; @param STRU1 {in}{required}
+; Structure which can have same elements's name than 
+; STRU2 but with a different value.
 ;
-; CALLING SEQUENCE: rs=mixstru(stru1,stru2)
-; 
-; INPUTS: stru1 et stu2 sont 2 structures qui peuvent avoir des
-; elements portant le meme nom mais avec une valeur differente.
+; @param STRU2 {in}{required}
+; Structure which can have same elements's name than 
+; STRU1 but with a different value.
 ;
-; KEYWORD PARAMETERS: none
+; @returns
+; A stucture
 ;
-; OUTPUTS: une stucture
+; @restrictions
+; If STRU1 or  STRU2 is not a structure, mixstru send back -1
 ;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS: si stru1 ou stru2 ne sont pas des structures mixstru
-; renvoie -1
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples
 ;     
 ;     IDL> a=get_extra(/toto,ok=123)
@@ -53 +52 @@
 ;        YEAR            INT           1999
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      7/10/1999
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------