Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/DIVERS/projsegment.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/PLOTS/DIVERS/projsegment.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/PLOTS/DIVERS/projsegment.pro

@@ -2 +2 @@
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-; NAME: projsegment
+;+
 ;
-; PURPOSE: projecte lineairement un segment un vecteur dont les bornes
-; sont [a,b] sur un vecteur dont les bornes sont [c,d]
+; @file_comments
+; project linearly a segment, a vector whose boundaries are [a,b] on 
+; a vector whose boundaries are [c,d]
 ;
-; CATEGORY: caculs a 2 francs
+; @categories
+; calculation
 ;
-; CALLING SEQUENCE: res=projsegment(vecteur, bornes) 
+; @param VECTEUR
+; A vector whose the first element must be the smallest one and the last must be the biggest one.
 ;
-; INPUTS: vecteur: un vecteur dont le premier element doit etre le
-; plus petit element et le dernier doit etre le plus grand.
-;         bornes: les nouvelles bornes du vecteur.
+; @param BORNES 
+; New boundaries of the vector.
 ;
-; KEYWORD PARAMETERS:
+; @keyword MP
+; Activate this keyword to the function send back this a vector of 2 
+; elements which are the m and p of the linear projection y=mx+p used 
+; to pass from the [a,b] segment to the [c,d] segment.
 ;
-;         /MP: activer ce motcle pour que la fonction retourne un
-;         vecteur de 2 elements qui sont les coefficient m et p de la
-;         projection lineaire y=mx+p utilisee pour passer du segment
-;         [a,b] au segment [c,d]
+; @returns 
+; A vector whose new boudaries are specified by BORNES.
 ;
-; OUTPUTS:un vecteurs dont les nouvelles bornes sont specifiees par
-; bornes
-;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples
 ;   
 ;   IDL> a=indgen(9) 
@@ -43 +37 @@
 ;        -80     -70     -60     -50     -40     -30     -20     -10      0
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       24/6/1999
+;
+; @version
+; $Id$
+;
+;-
 ;------------------------------------------------------------
 ;------------------------------------------------------------