Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/LABEL/lonaxe.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/PLOTS/LABEL/lonaxe.pro (modified) (4 diffs)

trunk/SRC/ToBeReviewed/PLOTS/LABEL/lonaxe.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:LONAXE
 ;
-; PURPOSE:fonction appelee par [XYZ]TICKFORMAT (cf l'help pour voir
-;         comment l'utiliser) pour labeller les axes en longitude.
+; @file_comments
+; function called by [XYZ]TICKFORMAT (see the help to see how to use it) to label axes in longitude.
 ;
-; CATEGORY:graphe
+; @categories
+; graphic
+; 
+; @param AXIS 
+; It is the axis number: 0 for X axis, 1 for Y axis, 2 for Z axis.
 ;
-; CALLING SEQUENCE:[XYZ]TICKFORMAT='lonaxe'
+; @param INDEX
+; It is the tick mark index which starts at 0.
+;       
+; @param VALUE
+; It is the default tick mark value (a floating-point number).
 ;
-; INPUTS:fournis (et imposes) automatiquement par IDL: axis, index, value:
-;       Axis is the axis number: 0 for X axis, 1 for Y axis, 2 for Z axis.
-;       Index is the tick mark index which starts at 0.
-;       Value is the default tick mark value (a floating-point number).
-; KEYWORD PARAMETERS:
+; @returns
+; A string, used automatically to label
 ;
-; OUTPUTS:un string, utilise automatiquement pour labeller
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       ???
+;                       14/10/1999 format of labels
 ;
-; COMMON BLOCKS:
+; @version
+; $Id$
 ;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       ???
-;                       14/10/1999 format des labels
 ;-
 ;------------------------------------------------------------
@@ -37 +36 @@
 FUNCTION lonaxe, axis, index, value
 ;------------------------------------------------------------
-; on ramenne value ds le segment [0,360[
+; We put back value in the segment [0,360[
 ;
   compile_opt idl2, strictarrsubs
@@ -43 +42 @@
    lon=value mod 360
    if lon lt 0 then lon=lon+360
-; format des labels:
+; format of labels:
    case 1 of
       lon EQ round(lon):fmt = 'i4'
@@ -49 +48 @@
       ELSE:fmt = 'f7.2'
    endcase
-; on ecrit le label
+; we write the label
    if lon lt 180 then nom=string(lon,     format='('+fmt+',''E'')')
    if lon gt 180 then nom=string(360-lon, format='('+fmt+',''W'')')