Changeset 254 for trunk


Ignore:
Timestamp:
06/26/07 17:58:20 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

Location:
trunk/SRC
Files:
27 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Obsolete/lec.pro

    r232 r254  
    7171; @returns 
    7272; un tableau 2 ou 3d. sans le mot cle /TOUT, sa taille est 
    73 ; celle du sous domaine definit par domdef (nx,ny,nz). avec /TOUT le 
     73; celle du sous domaine definit par <pro>domdef</pro>(nx,ny,nz). avec /TOUT le 
    7474; champ a la taille du  domaine qui a etait selectionne pour la 
    7575; cession en cours (jpi,jpj,jpk). 

  • trunk/SRC/Obsolete/nlec.pro

    r232 r254  
    3232; 
    3333; @keyword TOUT 
    34 ; oblige a lire le tableau entier en non pas celui reduit a domdef 
     34; oblige a lire le tableau entier en non pas celui reduit a <pro>domdef</pro> 
    3535; 
    3636; @keyword STRUCTURE 

  • trunk/SRC/Obsolete/nlec5j.pro

    r232 r254  
    3434; 
    3535; @keyword TOUT 
    36 ; oblige a lire le tableau entier en non pas celui reduit a domdef 
     36; oblige a lire le tableau entier en non pas celui reduit a <pro>domdef</pro> 
    3737; 
    3838; @keyword _EXTRA 

  • trunk/SRC/Obsolete/nlecan.pro

    r238 r254  
    3131; 
    3232; @keyword TOUT 
    33 ; oblige a lire le tableau entier en non pas celui reduit a domdef 
     33; oblige a lire le tableau entier en non pas celui reduit a <pro>domdef</pro> 
    3434; 
    3535; @keyword _EXTRA 

  • trunk/SRC/Obsolete/nlecmois.pro

    r231 r254  
    1616; 
    1717; @keyword TOUT 
    18 ; oblige a lire le tableau entier en non pas celui reduit a domdef 
     18; oblige a lire le tableau entier en non pas celui reduit a <pro>domdef</pro> 
    1919; 
    2020; @keyword _EXTRA 

  • trunk/SRC/Obsolete/nlecsaison.pro

    r232 r254  
    3232; 
    3333; @keyword TOUT 
    34 ; oblige a lire le tableau entier en non pas celui reduit a domdef 
     34; oblige a lire le tableau entier en non pas celui reduit a <pro>domdef</pro> 
    3535; 
    3636; @keyword _EXTRA 

  • trunk/SRC/Obsolete/nlecserie.pro

    r232 r254  
    2929; 
    3030; @keyword TOUT 
    31 ; oblige a lire le tableau entier en non pas celui reduit a domdef 
     31; oblige a lire le tableau entier en non pas celui reduit a <pro>domdef</pro> 
    3232; 
    3333; @keyword _EXTRA 

  • trunk/SRC/ToBeReviewed/CALCULS/grossemoyenne.pro

    r245 r254  
    1616; 
    1717; @keyword BOXZOOM 
    18 ; [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see domdef 
    19 ; boxzoom can have 5 forms: 
     18; [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see <pro>domdef</pro> 
     19; boxzoom can have 5 forms : 
    2020; [vert2], [vert1, vert2],[lon1, lon2, lat1, lat2], 
    2121; [lon1, lon2, lat1, lat2, vert2],[lon1, lon2, lat1, lat2, vert1,vert2] 
    … …  
    6161; result:un tableau 
    6262; common 
    63 ; domdef 
     63; <pro>domdef</pro> 
    6464; 
    6565; @restrictions 

  • trunk/SRC/ToBeReviewed/CALCULS/moyenne.pro

    r237 r254  
    1515; 
    1616; @keyword BOXZOOM 
    17 ; [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see domdef 
     17; [xmin,xmax,ymin,ymax (,(zmin,)zmax)] to more details, see <pro>domdef</pro> 
    1818; boxzoom can have 5 forms: 
    1919;  [vert2], 
    … …  
    4747; @uses 
    4848; common 
    49 ; domdef 
     49; <pro>domdef</pro> 
    5050; 
    5151; @restrictions 

  • trunk/SRC/ToBeReviewed/CALCULS/norme.pro

    r232 r254  
    2121; @keyword BOXZOOM 
    2222; boxzoom on which do the average (by default the domain selected 
    23 ; by the last domdef done) 
     23; by the last <pro>domdef</pro> done) 
    2424; 
    2525; @keyword DIREC 
    … …  
    4141; When we calculate on a reduce geographic domain, field U and V have not 
    4242; necessarily the same number of point. In this case, we recut U and V to 
    43 ; keep only common points. We profit of this to redo a domdef which redefine 
     43; keep only common points. We profit of this to redo a <pro>domdef</pro> which redefine 
    4444; a geographic domain on which fields U and V are extracted on same points 
    4545; 

  • trunk/SRC/ToBeReviewed/GRILLE/decoupeterre.pro

    r232 r254  
    22; 
    33; @file_comments 
    4 ; Similar to grille. Here, when vargrid is not 'T' or 'W', we have to 
    5 ; recuperate Tmask, glamt, gphit and the array of triangulation on the 
    6 ; considered sub-domain for the drawing. The specificity of decoupeterre 
    7 ; in comparaison with grille, is that we take, if possible, a sub-domain 
    8 ; just a little bit bigger than the one defined by domdef in order to be 
     4; Similar to <pro>grille</pro>.  
     5; Here, when vargrid is not 'T' or 'W', we have to 
     6; recuperate tmask, glamt, gphit and the array of triangulation on the 
     7; considered sub-domain for the drawing.  
     8; The specificity of decoupeterre, in comparaison with <pro>grille</pro>, is  
     9; that we take, if possible, a sub-domain just a little bit bigger than the  
     10; one defined by <pro>domdef</pro> in order to be 
    911; sure that the mask we draw will cover over all the drawing. 
    1012; 

  • trunk/SRC/ToBeReviewed/GRILLE/domdef.pro

    r240 r254  
    2727; @keyword ENDPOINTS {type=vector} 
    2828; A four elements vector [x1,y1,x2,y2] used to specify 
    29 ; that domdef must define the box used to make a plot (pltz, pltt, 
     29; that <pro>domdef</pro> must define the box used to make a plot (pltz, pltt, 
    3030; plt1d) done strictly along the line (that can have any direction) 
    3131; starting at (x1, y1) ending at (x2, y2). When defining endpoints, 
    … …  
    4848; box which do not concern the same array indexes. This is sometimes a 
    4949; problem (or at least serious complications) in programs where several 
    50 ; type of grid intervene (see norme, curl...). Activate MEMEINDICE to 
    51 ; force domdef to take same indexes -those of the grid T- for all other 
    52 ; grids. 
     50; type of grid intervene (see norme, curl...).  
     51; Activate MEMEINDICES to force <pro>domdef</pro> to take same indexes - those  
     52; of the grid T- for all other grids. 
    5353; 
    5454; @keyword INDEX 
    55 ; We activate it if we want that all elements passed in input of domdef 
    56 ; refer to indexes of glam, gphi and gdep arrays rather than to values 
    57 ; of these arrays. 
     55; We activate it if we want that all elements passed in input of  
     56; <pro>domdef</pro> refer to indexes of glam, gphi and gdep arrays rather  
     57; than to values of these arrays. 
    5858; 
    5959; @keyword XINDEX 
    60 ; We activate it if we want that all elements passed in input of domdef 
     60; We activate it if we want that all elements passed in input of  
     61; <pro>domdef</pro>  
    6162; and concerning the X dimension refer to indexes of glam arrays rather 
    6263; than to values of these arrays. 
    6364; 
    6465; @keyword YINDEX 
    65 ; We activate it if we want that all elements passed in input of domdef 
     66; We activate it if we want that all elements passed in input of  
     67; <pro>domdef</pro> 
    6668; and concerning the X dimension refer to indexes of gphi arrays rather 
    6769; than to values of these arrays. 
    6870; 
    6971; @keyword ZINDEX 
    70 ; We activate it if we want that all elements passed in input of domdef 
     72; We activate it if we want that all elements passed in input of  
     73; <pro>domdef</pro> 
    7174; and concerning the X dimension refer to indexes of gdep arrays rather 
    7275; than to values of these arrays. 

  • trunk/SRC/ToBeReviewed/GRILLE/tracegrille.pro

    r248 r254  
    66; @categories 
    77; 
    8 ; @param GLAMIN {in}{optional}{type=1d or 2d array}{default=glam specified by vargrid, on the domain defined by domdef} 
     8; @param GLAMIN {in}{optional}{type=1d or 2d array}{default=glam specified by vargrid, on the domain defined by <pro>domdef</pro>} 
    99; Longitude of points of the grid. 
    1010; 
    11 ; @param GPHIIN {in}{optional}{type=1d or 2d array}{default=gphi specified by vargrid, on the domain defined by domdef} 
     11; @param GPHIIN {in}{optional}{type=1d or 2d array}{default=gphi specified by vargrid, on the domain defined by <pro>domdef</pro>} 
    1212; Latitude of points of the grid. 
    1313; 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt.pro

    r251 r254  
    3535; 6 elements: The extraction is made on Boxzoom 
    3636; 
    37 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     37; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     38; <pro>domdef</pro> ! 
    3839; 
    3940; @keyword REALCONT 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/plt1d.pro

    r251 r254  
    4040; 6 elements: The extraction is made on Boxzoom 
    4141; 
    42 ; Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last domdef! 
    43 ; 
    44 ; @keyword COL1d 
     42; Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last  
     43; <pro>domdef</pro> ! 
     44; 
     45; @keyword COL1D 
    4546;  --OBSOLETE--Color number when we make a trace 1d by default, 0. 
    4647; It is better to use the keyword COLOR used by plot. 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltt.pro

    r251 r254  
    4646; 6 elements: The extraction is made on Boxzoom 
    4747; 
    48 ; Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last domdef! 
     48; Where lon1, lon2,lat1,lat2,vert1,vert2 are global variables defined at the last  
     49; <pro>domdef</pro> ! 
    4950; 
    5051; @keyword CONTINTERVALLE 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltv.pro

    r251 r254  
    3131; 6 elements: The extraction is made on Boxzoom 
    3232; 
    33 ; Where lon1, lon2, lat1, lat2 are global variables defined at the last domdef! 
     33; Where lon1, lon2, lat1, lat2 are global variables defined at the last  
     34; <pro>domdef</pro> ! 
    3435; 
    3536; @keyword C_NAN {default=!d.n_colors < 255} 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltz.pro

    r251 r254  
    3232; 6 elements: The extraction is made on Boxzoom 
    3333; 
    34 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     34; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     35; <pro>domdef</pro> ! 
    3536; 
    3637; @keyword CONTINTERVALLE 

  • trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildcmd.pro

    r231 r254  
    1515;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    1616;   6 elements: The extraction is made on Boxzoom 
    17 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     17; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     18; <pro>domdef</pro> ! 
    1819; 
    1920; @keyword FORCETYPE 

  • trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildreadcmd.pro

    r231 r254  
    1818;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    1919;   6 elements: The extraction is made on Boxzoom 
    20 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     20; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     21; <pro>domdef</pro> ! 
    2122; 
    2223; @keyword COMPLETE 

  • trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/changefield.pro

    r231 r254  
    1818;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    1919;   6 elements: The extraction is made on Boxzoom 
    20 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     20; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     21; <pro>domdef</pro> ! 
    2122; 
    2223; @returns 

  • trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/changefile.pro

    r231 r254  
    1818;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    1919;   6 elements: The extraction is made on Boxzoom 
    20 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     20; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     21; <pro>domdef</pro> ! 
    2122; 
    2223; @keyword DATE1 

  • trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/read_vermair.pro

    r231 r254  
    2424;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    2525;   6 elements: The extraction is made on Boxzoom 
    26 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     26; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     27; <pro>domdef</pro> ! 
    2728; 
    2829; @keyword _EXTRA 

  • trunk/SRC/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_domain.pro

    r232 r254  
    516516;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    517517;   6 elements: The extraction is made on Boxzoom 
    518 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     518; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     519; <pro>domdef</pro>! 
    519520; 
    520521; @keyword _EXTRA 

  • trunk/SRC/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slide_slice.pro

    r238 r254  
    177177;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    178178;   6 elements: The extraction is made on Boxzoom 
    179 ; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef! 
     179; Where lon1, lon2,lat1,lat2 are global variables defined at the last  
     180; <pro>domdef</pro> ! 
    180181; 
    181182; @keyword COLUMN 

  • trunk/SRC/ToBeReviewed/WIDGET/slec.pro

    r238 r254  
    2424;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 
    2525;   6 elements: The extraction is made on Boxzoom 
    26 ; where lon1,lon2,lat1,lat2 are global variables defined at the last domdef! 
     26; where lon1,lon2,lat1,lat2 are global variables defined at the last  
     27; <pro>domdef</pro> ! 
    2728; 
    2829; @keyword _EXTRA 

  • trunk/SRC/Utilities/fitintobox.pro

    r238 r254  
    44; Check that the input array has size and dimensions 
    55; compatible with the domain that was defined with the previous call 
    6 ; of domdef. 
     6; of <pro>domdef</pro>. 
    77; 
    88; @categories 
Note: See TracChangeset for help on using the changeset viewer.