Ignore:
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)

Location:
trunk/SRC/ToBeReviewed/PLOTS/DIVERS
Files:
15 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/addaxe.pro

    r157 r163  
    1212; 
    1313; @param ENDPOINTS {in}{required} 
    14 ; Coordonnees of extremities of the section 
     14; Coordinate of extremities of the section 
    1515;  
    16 ; @param TYPE {in}{required} 
     16; @param TYPE {in}{required}{type=string} 
    1717; A string of two characters specifying the type of plot we do 
    1818; 
    19 ; @param POSFENETRE {in}{required} 
     19; @param POSFENETRE {in}{required}{type=vector} 
    2020; The vector !p.position corresponding to the frame position of  
    2121; the drawing part of the plot. 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/autoscale.pro

    r157 r163  
    1717; A reel number specifying below what value we want to trace a contour 
    1818; 
    19 ; @param CI. {out} 
     19; @param CI. {out}{type=real} 
    2020; It is a reel number giving the contour interval. Use it in CONTOUR with the keyword LEVEL. 
    2121; 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/axis4pltz.pro

    r157 r163  
    2929; latitude when we make a drawing f(y) 
    3030; 
    31 ; @keyword ZRATIO 
     31; @keyword ZRATIO {default=2./3} 
    3232; When the drawing has a zoomed part, it is the size rapport between the zoomed part,  
    33 ; hz (zoom height), and the whole drawing, ht (total height). By default =2./3 
     33; hz (zoom height), and the whole drawing, ht (total height). 
    3434; 
    3535; @keyword _EXTRA 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/barrecouleur.pro

    r157 r163  
    99; @categories 
    1010; Utilities 
     11; 
     12; @param COLNUMB 
     13; 
     14; 
     15; @param CLBINF 
     16; 
     17; 
     18; @param CLBSUP 
     19; 
     20; 
     21; @param CLBDIV 
     22; 
     23; 
     24; @keyword NOCOLORBAR 
     25;  
     26; 
     27; @keyword CB_TITLE 
     28;  
     29; 
     30; @keyword NOFILL 
     31;  
     32; 
     33; @keyword COLOR_c 
     34;  
     35; 
     36; @keyword MIN 
     37; Scalar used to specify the min value to be drawn. 
     38; 
     39; @keyword MAX 
     40; Scalar used to specify the max value to be drawn. 
     41; 
     42; @keyword DIVISIONS 
     43;  
     44; 
     45; @keyword CB_SUBTITLE 
     46;  
     47; 
     48; @keyword POST 
     49;  
     50; 
     51; @keyword _EXTRA 
     52; Used to pass your keywords 
    1153; 
    1254; @restrictions pass all argument we want thanks to _extra 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.pro

    r157 r163  
    66;  
    77;  
    8 ; @param TYPE {in}{required} 
     8; @param TYPE {in}{required}{type=string} 
    99; A string of two characters specifying the type of plot we do 
    1010; 
    11 ; @param N1 {in}{required} 
     11; @param N1 {in}{required}{type=integer} 
    1212; Number of elements in the first dimension 
    1313; 
    14 ; @param N2 {in}{required} 
     14; @param N2 {in}{required}{type=integer} 
    1515; Number of elements in the second dimension 
    1616; 
    17 ; @param NAME {in} {optional} 
    18 ; It is a string giving the name of the file to be opened. If NAME 
     17; @param NAME {in}{optional}{type=string} 
     18; It gives the name of the file to be opened. If NAME 
    1919; does not contain the separating character of directories ('/' under 
    2020; unix for example), the file will be looked for in the current directory. 
    … …  
    5151;  
    5252;  
    53 ; @param TYPE {in}{required} 
     53; @param TYPE {in}{required}{type=string} 
    5454; A string of two characters specifying the type of plot we do 
    5555; 
    … …  
    101101;  
    102102;  
    103 ; @param TYPE {in}{required} 
     103; @param TYPE {in}{required}{type=string} 
    104104; A string of two characters specifying the type of plot we do 
    105105; 
    … …  
    157157; Graphics 
    158158;  
    159 ; @param FIELD {in}{required} 
    160 ; A field respecting litchamp.pro's criterions. See IDL>xhelp,'litchamp' 
     159; @param FIELD {in}{required}{type=field} 
     160; It respect litchamp.pro's criterions. See IDL>xhelp,'litchamp' 
    161161; 
    162162; @param PROCEDURE {in}{required} 
    … …  
    169169; 
    170170; 
    171 ; @keyword BOXZOOM  
     171; @keyword BOXZOOM {type=vector} 
    172172; Vector indicating the geographic zone on which we want to cut the map.  
    173173;  If BOXZOOM has : 
    … …  
    181181; 
    182182; @keyword WDEPTH 
    183 ; to specify that the field is at W depth instad of T  
     183; to specify that the field is at W depth instead of T  
    184184; depth (automatically activated if vargrid eq 'W') 
    185185;  
    186 ; @keyword VECTEUR 
     186; @keyword VECTEUR{type=vetcor} 
    187187; It is a structure composed by 2 elements containing the 2 fields U 
    188188; and V of values of the zonal and meridian component of the vector of the fields 
    189189; to draw. These fields can be an array or a structure. 
    190190;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')} 
    191 ;       Comment: name of elements of vectors are inconsenquential. 
     191;       Comment: name of elements of vectors are inconsequential. 
    192192;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated. 
    193193; 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checktypeminmax.pro

    r157 r163  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    5 ; NAME: 
     2; @file_comments 
    63; 
    7 ; PURPOSE: 
    84; 
    9 ; CATEGORY: 
     5; @categories 
    106; 
    11 ; CALLING SEQUENCE: 
    12 ;  
    13 ; INPUTS: 
    147; 
    15 ; KEYWORD PARAMETERS: 
     8; @param PROCEDURE 
    169; 
    17 ; OUTPUTS: 
    1810; 
    19 ; COMMON BLOCKS:common.pro 
     11; @keyword TYPE 
    2012; 
    21 ; SIDE EFFECTS: 
    2213; 
    23 ; RESTRICTIONS: 
     14; @keyword MIN 
    2415; 
    25 ; EXAMPLE: 
    2616; 
    27 ; MODIFICATION HISTORY:Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     17; @keyword MAX 
     18; 
     19; 
     20; @keyword XY 
     21; 
     22; 
     23; @keyword XZ 
     24; 
     25; 
     26; @keyword YZ 
     27; 
     28; 
     29; @keyword XT 
     30; 
     31; 
     32; @keyword YT 
     33; 
     34; 
     35; @keyword ZT 
     36; 
     37; 
     38; @keyword TT 
     39; 
     40; 
     41; @keyword XX 
     42; 
     43; 
     44; @keyword YY 
     45; 
     46; 
     47; @keyword ZZ 
     48; 
     49; 
     50; @keyword XINDEX 
     51; 
     52; 
     53; @keyword YINDEX 
     54; 
     55; 
     56; @keyword ENDPOINTS 
     57; 
     58; 
     59; @keyword _EXTRA 
     60; Used to pass your keywords 
     61; 
     62; @returns 
     63; 
     64; 
     65; @uses 
     66; common.pro 
     67; 
     68; @restrictions 
     69; 
     70; 
     71; @examples 
     72; 
     73; 
     74; @history 
     75; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     76; 
     77; @version 
     78; $Id$ 
    2879; 
    2980; @todo seb 
    3081;- 
    31 ;------------------------------------------------------------ 
    32 ;------------------------------------------------------------ 
    33 ;------------------------------------------------------------ 
     82; 
     83; 
    3484PRO checktypeminmax, procedure, TYPE = type, MIN = min, MAX = max, XY = xy $ 
    3585                     , XZ = xz, YZ = yz, XT = XT, YT = YT, ZT = zt $ 
    … …  
    3787                     , XINDEX = xindex, YINDEX = yindex $ 
    3888                     , ENDPOINTS = endpoints, _extra = ex 
    39 ; 
    40 ; 
    4189  compile_opt idl2, strictarrsubs 
    4290; 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/determineminmax.pro

    r157 r163  
    1616; The mask array  
    1717; 
    18 ; @keyword MININ  
    19 ; It is a scalar which, if it is not defined, take the value of VRAIMIN 
     18; @keyword MININ {type=scalar} 
     19; If it is not defined, it takes the value of VRAIMIN 
    2020; 
    21 ; @keyword MAXIN  
    22 ; It is a scalar which, if it is not defined, take the value of VRAIMAX 
     21; @keyword MAXIN {type=scalar} 
     22; If it is not defined, it takes the value of VRAIMAX 
    2323; 
    2424; @keyword ZEROMIDDLE  

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/givewindowsize.pro

    r142 r163  
    11;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @returns 
     9; 
     10; 
     11; @uses 
     12; 
     13; 
     14; @restrictions 
     15; 
     16; 
     17; @examples 
     18; 
     19; 
     20; @history 
     21; 
     22; 
     23; @version 
     24; $Id$ 
    225; 
    326; @todo seb 
    4 ; 
    527;- 
    6 ; 
    728FUNCTION givewindowsize 
    8 ; 
     29 
    930;------------------------------------------------------------ 
    1031; include commons 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/meridienparallele.pro

    r157 r163  
    1010; Graphics 
    1111; 
    12 ; @param COUPE The type of drawing we treat 
     12; @param COUPE  
     13; The type of drawing we treat 
    1314; 
    1415; @uses 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/placecolor.pro

    r157 r163  
    66; @file_comments 
    77; allows to trace the independently from a graph 
    8 ; By default, trace a color bar of the same type tahn the one present in plt 
     8; By default, trace a color bar of the same type than the one present in plt 
    99; and pltz. If max, min and divisions are not stipulated, then max=sup,min=inf 
    1010; and divisions=div. 
    … …  
    1414; 
    1515; @param POS 
    16 ; Vecteur composed by 4 elements giving coordinates of the left bottom  
     16; Vector composed by 4 elements giving coordinates of the left bottom  
    1717; corner and of the right up one -in cm- in which we want to do the color bar 
    1818; 
    … …  
    2424; 
    2525; @restrictions 
    26 ; Only usable for POSTCRIPTs effectuated with plein2dessin 
     26; Only usable for Postscripts effectuated with plein2dessin 
    2727; 
    2828; @history 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/placedessin.pro

    r157 r163  
    1010; Utilities 
    1111; 
    12 ; @param TYPEDESSIN 
    13 ; It is a chain or characteres specifying what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt' 
     12; @param TYPEDESSIN {type=string} 
     13; It specify what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt' 
    1414; 
    1515; @keyword LANDSCAPE  
    16 ; Force the page or the window on the screen to be in lenthened position. 
    17 ; 
    18 ; @keyword LCT  
    19 ; Is an integer designating the number of the palette of color we want to use for the plot.  
     16; Force the page or the window on the screen to be in lengthened position. 
     17; 
     18; @keyword LCT {type=integer} 
     19; It designate the number of the palette of color we want to use for the plot.  
    2020;        
    2121; @keyword MAP  
    2222; We use it when we want to do a projection. 
    2323; This keyword can be of two types: 
    24 ;     MAP=[P0lat,P0lon,Rot]. For the descrption of these 3 values (see the online help of MAP_SET). 
    25 ;     /MAP: In this case, map is automatically caculated have the value:  
     24;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET). 
     25;     /MAP: In this case, map is automatically calculated have the value:  
    2626;          map = [0, (lon1+lon2)/2., 0] 
    2727; Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo: 
    2828; IDL> demo 
    2929; Then choose earth sciences and  mapping. 
    30 ; Comment2: By default it  is a cindrical projection which is effectuated (with or without the keyword map).  
     30; Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map).  
    3131; If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection. 
    3232; For example, for a polar projection centered on the south pole: 
    … …  
    4444; 
    4545; @keyword SMALL  
    46 ; Vector composed of 3 or 4 elements, applyed to make a drawing on a  
     46; Vector composed of 3 or 4 elements, applied to make a drawing on a  
    4747; small portion of a page or screen. It delimit the zone where the drawing will be done. 
    4848;     If there is 4 elements: 
    49 ; then is constituated of coordinates (expressed in cm located from the up and  
    50 ; left corner of the page or the window (in portrait like in lanscape)) of the bottom  
     49; then is constituted of coordinates (expressed in cm located from the up and  
     50; left corner of the page or the window (in portrait like in landscape)) of the bottom  
    5151; and left corner and of the up and right corner of the drawing zone. 
    5252;     If there is 3 elements: 
    … …  
    5555; the number 1 and then, following the writing direction. 
    5656; By default, we make the largest drawing we can do, conserving the aspect rapport  
    57 ; (exept when REMPLI is activated). 
     57; (except when REMPLI is activated). 
    5858;  
    5959; @keyword PORTRAIT  
    … …  
    6767; Force the drawing to occupy the whole space defined by small. 
    6868; 
    69 ; @keyword WINDOW 
     69; @keyword WINDOW  
    7070; Number of the window on which we want to do the graph (Allow to open several windows).  
    7171; By default, we open 'IDL0' 
    … …  
    7676; @keyword CONTOUR  
    7777; If we want to trace contours of a different field than the one  
    78 ; whose we have the colored drawing (by examlpe E-P in color and QSR in contours).  
    79 ; It must be a field respecting same caracteristics than the argument number one of plt. 
     78; whose we have the colored drawing (by example E-P in color and QSR in contours).  
     79; It must be a field respecting same characteristics than the argument number one of plt. 
    8080; 
    8181; @keyword ENDPOINTS  
    82 ; keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities  
    83 ; of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
     82; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities  
     83; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are  
    8484; coordinates.  
    8585; 
    86 ; @keyword VECTEUR 
     86; @keyword VECTEUR {type=vector} 
    8787; It is a structure composed by 2 elements containing the 2 fields U 
    8888; and V of values of the zonal and meridian component of the vector of the fields 
    8989; to draw. These fields can be an array or a structure. 
    9090;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')} 
    91 ;       Comment: name of elements of vectors are inconsenquential. 
     91;       Comment: name of elements of vectors are inconsequential. 
    9292;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated. 
    9393; 
    … …  
    103103; with filling in color  
    104104; 
    105 ; @param POSFENETRE {out} 
     105; @param POSFENETRE {out}{type=vector} 
    106106; It is a vector composed by 4 elements containing the position of the frame  
    107 ; containing captions and the graph in normalized coorinates.  
     107; containing captions and the graph in normalized coordinates.  
    108108; Comment: To position the drawing; we have to do !p.position=posfenetre  
    109109; after the call of the caliber 
    110110; 
    111 ; @param POSBAR {out} 
     111; @param POSBAR {out}{type=vector} 
    112112; Like POSFENETRE but for the color bar.  
    113113; Same comment to position the color bar, !p.position=posbar 

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

    r157 r163  
    1111; Calculation 
    1212; 
    13 ; @param VECTEUR 
     13; @param VECTEUR {type=vector} 
    1414; A vector whose the first element must be the smallest one and the last must be the biggest one. 
    1515; 
    … …  
    2323; 
    2424; @returns  
    25 ; A vector whose new boudaries are specified by BORNES. 
     25; A vector whose new boundaries are specified by BORNES. 
    2626; 
    2727; @examples 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/restoreatt.pro

    r157 r163  
    66; @file_comments 
    77; Allows to reattribuate global variables associated with a field  
    8 ; when we give a stucture created by saveatt.pro by example. 
     8; when we give a structure created by saveatt.pro by example. 
    99; 
    1010; @categories  

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/rotation.pro

    r142 r163  
    55;            
    66; @param X {in}{required} 
    7 ; orignal data point pairs 
     7; original data point pairs 
    88; 
    99; @param Y {in}{required} 
    10 ; orignal data point pairs 
     10; original data point pairs 
    1111;            
    1212; @param DEG {in}{required} 
    … …  
    2727;- 
    2828 
    29 PRO ROTATION,X,Y,DEG,NX,NY 
     29PRO rotation,X,Y,DEG,NX,NY 
    3030; 
    3131  compile_opt idl2, strictarrsubs 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/terminedessin.pro

    r157 r163  
    1414; If we make several drawing, use \@ps. 
    1515; 
    16 ; @keyword SMALL  
    17 ; Vector composed of 3 or 4 elements, applyed to make a drawing on a  
     16; @keyword SMALL {type=vector}  
     17; Vector composed of 3 or 4 elements, applied to make a drawing on a  
    1818; small portion of a page or screen. It delimit the zone where the drawing will be done. 
    1919;     If there is 4 elements: 
    20 ; then is constituated of coordinates (expressed in cm located from the up and  
    21 ; left corner of the page or the window (in portrait like in lanscape)) of the bottom  
     20; then is constituted of coordinates (expressed in cm located from the up and  
     21; left corner of the page or the window (in portrait like in landscape)) of the bottom  
    2222; and left corner and of the up and right corner of the drawing zone. 
    2323;     If there is 3 elements: 
    … …  
    2626; the number 1 and then, following the writing direction. 
    2727; By default, we make the largest drawing we can do, conserving the aspect rapport  
    28 ; (exept when REMPLI is activated). 
     28; (except when REMPLI is activated). 
    2929; 
    3030; @keyword _EXTRA  
Note: See TracChangeset for help on using the changeset viewer.