Changeset 163 for trunk/SRC/ToBeReviewed/POSTSCRIPT/calibre.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/ToBeReviewed/POSTSCRIPT/calibre.pro (modified) (4 diffs)

trunk/SRC/ToBeReviewed/POSTSCRIPT/calibre.pro

@@ -14 +14 @@
 ; 
 ; @param RAPPORTYX {in}{required}
-; Scale rapport between the lenght of the y axis and the x one. For example, 
+; Scale rapport between the length of the y axis and the x one. For example, 
 ; for an xy map: RAPPORTYX=(lat2-lat1)/(lon2-lon1)
 ;
-; @param MARGE {in}{required}
+; @param MARGE {in}{required}{type=vector}
 ; Vector made of 4 elements containing the size of the left, right, up and 
 ; bottom margin having to surround the graph. All is measured in lines of characters.
 ;
-; @param MARGEBAR {in}{required}
+; @param MARGEBAR {in}{required}{type=vector}
 ; Vector made of 4 elements containing the size of the left, right and bottom 
-; margin and -BEWARE- the last element is this time the positio of the right up 
+; margin and -BEWARE- the last element is this time the position of the right up 
 ; corner, having to surround the color bar. All is measured in lines of characters.
 ;
-; @param SMALLDRAW {in}{required}
+; @param SMALLDRAW {in}{required}{type=vector}
 ; 2 possibilities:
 ;    It is vector made of 4 elements giving (in portrait or landscape) the position 
@@ -46 +46 @@
 ; This keyword can be used in 2 cases:
 ;   1) YXASPECT=1 : force RAPPORTYX to be respected otherwise, Calibre take the 
-;   initiative to change it a little inthe case of the aspect rapport of SMALL 
+;   initiative to change it a little in the case of the aspect rapport of SMALL 
 ;   is too different of the one of SMALLDRAW. 
 ;   2) YXASPECT=n : multiply by n the aspect rapport given by default. 
@@ -56 +56 @@
 ; 
 ; @keyword LANDSCAPE       
-; Force the page or the window on the screen to be in lenthened position.
+; Force the page or the window on the screen to be in lengthened position.
 ; 
 ; @keyword _EXTRA
 ; Used to pass your keywords
 ;
-; @param POSFENETRE
+; @param POSFENETRE {type=vector}
 ; It is a vector made of 4 elements containing the position of the frame 
 ; containing captions + the graph in normalized coordinates. 
@@ -67 +67 @@
 ; after the call of calibre.
 ;
-; @param POSBAR
+; @param POSBAR {type=vector}
 ; See POSFENTRE but for the color bar. Same comment to position the color bar, !p.position=POSBAR
 ;