Changeset 230 for trunk


Ignore:
Timestamp:
03/19/07 11:17:59 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

Location:
trunk/SRC
Files:
19 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/xmldoc/faqsaxo.xml

    r188 r230  
    292292You won't see  online help update if you are working with the official distribution because of <varname>!HELP_PATH</varname>. To override this problem, when you are in <filename class="directory"><replaceable>SAXO_basedirectory</replaceable>/SAXO_DIR/SRC/Documentation/xmldoc/</filename>,  you can call online help like this : 
    293293     <screen format="linespecific"> 
    294        <prompt>IDL</prompt> <userinput><command>ONLINE_HELP</command>,<option>book="../idldoc_assistant_output/idldoc-lib.adp"</option></userinput> 
     294       <prompt>&promptidl;</prompt> <userinput><command>ONLINE_HELP</command>,<option>book="../idldoc_assistant_output/idldoc-lib.adp"</option></userinput> 
    295295     </screen> 
    296296</para> 

  • trunk/SRC/Grid/changemsk.pro

    r163 r230  
    33;------------------------------------------------------------ 
    44; 
    5 ; @file_comments add land points on a 2D land-sea mask 
     5; @file_comments 
     6; add land points on a 2D land-sea mask 
    67; 
    78; @categories  
    89; Grid 
    910; 
    10 ; @param TAB {in}{required} a 2D land-sea mask, with 1 on sea and 0 on land 
     11; @param TAB {in}{required}  
     12; a 2D land-sea mask, with 1 on sea and 0 on land 
    1113; 
    1214; @keyword CELLSIZE  

  • trunk/SRC/Matrix/different.pro

    r163 r230  
    44;+ 
    55; 
    6 ; @file_comments  
     6; @file_comments 
    77; calculate the different elements of 2 matrix of positive whole numbers. 
    88; 
    … …  
    1010; Calculation 
    1111; 
    12 ; @param a {in}{required} arrays of positive integers, which need 
     12; @param a {in}{required}  
     13; arrays of positive integers, which need 
    1314;               not be sorted. Duplicate elements are ignored, as they have no 
    1415;               effect on the result 
    1516; 
    16 ; @param b {in}{required} see a 
     17; @param b {in}{required}  
     18; see a 
    1719; 
    18 ; @returns tableau 
     20; @returns 
     21; tableau 
    1922; 
    20 ; @restrictions The empty set is denoted by an array with the first element equal to 
     23; @restrictions  
     24; The empty set is denoted by an array with the first element equal to 
    2125; -1. 
    2226; 
    23 ; @restrictions These functions will not be efficient on sparse sets with wide 
     27; @restrictions  
     28; These functions will not be efficient on sparse sets with wide 
    2429; ranges, as they trade memory for efficiency. The HISTOGRAM function 
    2530; is used, which creates arrays of size equal to the range of the 
    … …  
    2833; @examples 
    2934; 
    30 ;  a = [2,4,6,8] 
    31 ;  b = [6,1,3,2] 
    32 ;  different(a,b) = [ 4, 8]         ; Elements in A but not in B 
     35;  IDL> a = [2,4,6,8] 
     36;  IDL> b = [6,1,3,2] 
     37;  IDL> different(a,b) = [ 4, 8]         ; Elements in A but not in B 
    3338; 
    34 ; @history http://www.dfanning.com/tips/set_operations.html 
     39; @history 
     40;  http://www.dfanning.com/tips/set_operations.html 
    3541; 
    36 ; @version $Id$ 
     42; @version 
     43; $Id$ 
    3744; 
    3845;- 
    … …  
    4047;------------------------------------------------------------ 
    4148;------------------------------------------------------------ 
    42 FUNCTION different, a, b   
     49FUNCTION different, a, b 
    4350; 
    4451  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Matrix/extrac2.pro

    r163 r230  
    5454; @returns 
    5555; a matrix 1,2,3 or 4d extract from input array 
     56; -1 in case of mistake 
    5657; 
    5758; @restrictions 
    58 ; -1 in case of mistake 
    5959; 
    6060; @examples 

  • trunk/SRC/Picture/imdisp.pro

    r163 r230  
    460460;map_grid 
    461461; 
    462 ; @history Liam.Gumley\@ssec.wisc.edu 
     462; @history 
     463; Liam.Gumley\@ssec.wisc.edu 
    463464; http://cimss.ssec.wisc.edu/~gumley 
    464465; 
    … …  
    479480; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. 
    480481; 
    481 ; @version $Id$ 
     482; @version 
     483; $Id$ 
    482484; 
    483485;- 

  • trunk/SRC/Picture/saveimage.pro

    r163 r230  
    1515;    8-bit or 24-bit output files are done automatically. 
    1616; 
    17 ; @categories Input/Output. 
     17; @categories 
     18; Input/Output 
    1819; 
    1920; @param FILE {in}{required}{default=format GIF} 
    … …  
    4849; If set, use the color cube method to quantize colors when 
    4950; creating 8-bit output which is read from a 24-bit display. 
    50 ; This may improve the accuracy of colors in the output image,  
     51; This may improve the accuracy of colors in the output image, 
    5152; especially white. 
    5253; 
    … …  
    5758; The output file is overwritten if it exists. 
    5859; 
    59 ; @restrictions 
    6060; requires IDL 5.0 or higher (square bracket array syntax). 
    6161; 
    … …  
    7070; IDL> saveimage, 'hurric.gif' 
    7171; 
    72 ; @history Liam.Gumley@ssec.wisc.edu 
     72; @history 
     73; Liam.Gumley@ssec.wisc.edu 
    7374; http://cimss.ssec.wisc.edu/~gumley 
    7475; 
    … …  
    8788; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. 
    8889; 
    89 ; @version $Id$ 
     90; @version 
     91; $Id$ 
    9092; 
    9193;- 

  • trunk/SRC/Picture/showimage.pro

    r186 r230  
    3636; IDL> showimage, filepath('rose.jpg', subdir='examples/data') 
    3737; 
    38 ; @history Liam.Gumley\@ssec.wisc.edu 
     38; @history 
     39; Liam.Gumley\@ssec.wisc.edu 
    3940; http://cimss.ssec.wisc.edu/~gumley 
    4041; 
    … …  
    5354; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. 
    5455; 
    55 ; @version $Id$ 
     56; @version 
     57; $Id$ 
    5658; 
    5759;- 

  • trunk/SRC/Postscript/closeps.pro

    r136 r230  
    1111; (number automatically found to be 1 larger that any of the existing ps file) 
    1212; 
    13 ; @keyword INFOWIDGET 
    14 ; A long integer giving the id of the information widget (created by openps) 
     13; @keyword INFOWIDGET {type=long integer} 
     14; id of the information widget (created by  
     15; <a href="./openps.html">openps</a> 
    1516; that we have to destroy at the end of closeps (when the postscript is done). 
    1617; 
    17 ; @uses cm_4ps 
     18; @uses  
     19; cm_4ps 
    1820; 
    19 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     21; @history 
     22; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2023;                       21/12/98 
    2124; June 2005: Sebastien Masson, english version with new commons 
    2225; 
    23 ; @version $Id$ 
     26; @version 
     27; $Id$ 
    2428; 
    2529;- 

  • trunk/SRC/Postscript/openps.pro

    r186 r230  
    2525; @keyword KEEP_PFONT 
    2626; activate to suppress the modification of !p.font 
    27 ; (by default we force  !p.font = 0  to make smaller postscripts) 
     27; (by default we force !p.font = 0  to make smaller postscripts) 
    2828; 
    2929; @keyword PORTRAIT 
    … …  
    5050; June 2005: Sebastien Masson, cleaning, english version with new commons 
    5151; 
    52 ; @version $Id$ 
     52; @version 
     53; $Id$ 
    5354; 
    5455;- 

  • trunk/SRC/Postscript/printps.pro

    r223 r230  
    3636; 
    3737; 
    38 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     38; @history 
     39; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3940;                       21/12/98 
    4041;                       25/8/19999 utilisation des widgets 
    … …  
    4243; June 2005: Sebastien Masson: cleaning, English version with new commons 
    4344; 
    44 ; @version $Id$ 
     45; @version 
     46; $Id$ 
    4547; 
    4648;- 
    … …  
    200202; visualize and/or print and/or archive. It can also refer 
    201203; to a gzipped postscript file. If needed, this name will 
    202 ; be completed by .ps and/or .gz 
    203 ; 
    204 ; @uses cm_4ps 
     204; be completed by .ps and/or .gz. 
     205; 
     206; @uses 
     207; cm_4ps 
    205208; 
    206209; @examples 
    207210; IDL> printps 
    208211; 
    209 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     212; @history 
     213; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    210214;                       21/12/98 
    211215;                       25/8/19999 utilisation des widgets 
    … …  
    213217; June 2005: Sebastien Masson: cleaning, English version with new commons 
    214218; 
    215 ; @version $Id$ 
     219; @version 
     220; $Id$ 
    216221; 
    217222;- 

  • trunk/SRC/ToBeReviewed/HOPE/read_hope.pro

    r226 r230  
    261261; 
    262262; @returns 
    263 ; -1 if typein and varnamein are undefine (this is the widget 
     263; -1 if typein and varnamein are undefined (this is the widget 
    264264; version) 
    265265; 

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

    r163 r230  
    11;+ 
    2 ;  
    3 ; @file_comments  
     2; 
     3; @file_comments 
    44; Create a bar graph, or overplot on an existing one. 
    55; 
    6 ; @categories  
     6; @categories 
    77; Graphics 
    88; 
    … …  
    6565; on the same graph. 
    6666; 
    67 ; @keyword OUTLINE  
     67; @keyword OUTLINE 
    6868; If set, this keyword specifies that an outline should be 
    6969; drawn around each bar. 
    7070; 
    71 ; @keyword OVERPLOT  
     71; @keyword OVERPLOT 
    7272; If set, this keyword specifies that the bar plot should be 
    7373; overplotted on an existing graph. 
    … …  
    7777; the background color. 
    7878; 
    79 ; @keyword ROTATE  
     79; @keyword ROTATE 
    8080; If set, this keyword indicates that horizontal rather than 
    8181; vertical bars should be drawn.  The bases of horizontal bars 
    8282; are on the left, "Y" axis and the bars extend to the right. 
    8383; 
    84 ; @examples By using the overplotting capability, it is relatively easy to create 
     84; @examples 
     85; By using the overplotting capability, it is relatively easy to create 
    8586;       stacked bar charts, or different groups of bars on the same graph. 
    8687; 
    … …  
    118119;       this could easily be changed.) 
    119120; 
    120 ; @history August 1990, T.J. Armitage, RSI, initial programming.  Replacement 
     121; @history 
     122; August 1990, T.J. Armitage, RSI, initial programming.  Replacement 
    121123;       for PLOTBAR and OPLOTBAR routines written by William Thompson. 
    122124; 
    … …  
    125127;       spacing the bars slightly. 
    126128; 
     129; @version 
    127130; $Id$ 
    128131; 

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

    r226 r230  
    5252; Used to pass your keywords 
    5353; 
    54 ; @restrictions pass all argument we want thanks to _extra 
     54; @restrictions 
     55; pass all argument we want thanks to _extra 
    5556; 
    5657; @history 
    … …  
    6162; $Id$ 
    6263; 
    63 ; @todo seb: mettre les keyword et les param 
     64; @todo 
     65; seb: mettre les keyword et les param 
    6466;- 
    6567;------------------------------------------------------------ 

  • trunk/SRC/ToBeReviewed/STRING/getwrd.pro

    r163 r230  
    44; @file_comments 
    55; Return the n'th word from a text string. 
    6 ;  
     6; 
    77; @categories 
     8; String 
    89; 
    9 ; @param TXTSTR {in}{required} 
     10; @param TXTSTR {in}{required} {type=string or array of strings} 
    1011; text string to extract from. 
    1112; The first element is used if txt is an array. 
    1213; 
    13 ; @param NTH {in}{required} 
     14; @param NTH {in}{required} {type=integer} {default=0} 
    1415; word number to get (first = 0 = def) 
    1516; 
    16 ; @param MTH {in}{required} 
     17; @param MTH {in}{optional} {type=integer} 
    1718; optional last word number to get. 
    1819; 
    1920; @keyword LOCATION 
    2021; = l.  Return word n string location. 
    21 ;          
     22; 
    2223; @keyword DELIMITER 
    2324; = d. Set word delimiter (def = space & tab). 
    24 ;          
     25; 
    2526; @keyword LAST 
    2627; means n is offset from last word.  So n=0 gives 
    … …  
    3031; @keyword NOTRIM 
    3132; suppresses whitespace trimming on ends. 
    32 ;  
     33; 
    3334; @keyword NWORDS 
    3435; = n. Returns number of words in string. 
    35 ;  
    36 ; @returns wrd = returned word or words. 
     36; 
     37; @returns 
     38; wrd = returned word or words. 
    3739; 
    3840; @uses 
    3941; getwrd_com 
    40 ;  
     42; 
    4143; @restrictions 
    4244; If a NULL string is given (txt="") then the last string 
    … …  
    7173;- 
    7274;------------------------------------------------------------- 
    73   
    74   
     75 
     76 
    7577        FUNCTION getwrd, TXTSTR, NTH, MTH, help=hlp, location=ll,$ 
    7678           delimiter=delim, notrim=notrim, last=last, nwords=nwords 
    77   
     79 
    7880        common getwrd_com, txtstr0, nwds, loc, len 
    79   
     81 
    8082        if (n_params(0) lt 1) or keyword_set(hlp) then begin 
    8183          print," Return the n'th word from a text string." 
    … …  
    103105          return, -1 
    104106        endif 
    105   
     107 
    106108        if n_params(0) lt 2 then nth = 0                ; Def is first word. 
    107109        IF N_PARAMS(0) LT 3 THEN MTH = NTH              ; Def is one word. 
    108   
     110 
    109111        if strlen(txtstr[0]) gt 0 then begin 
    110112          ddel = ' '                                    ; Def del is a space. 
    … …  
    118120          X = tb NE TST                                 ; Non-delchar (=words). 
    119121          X = [0,X,0]                                   ; 0s at ends. 
    120   
     122 
    121123          Y = (X-SHIFT(X,1)) EQ 1                       ; Diff=1: word start. 
    122124          Z = WHERE(SHIFT(Y,-1) EQ 1)                   ; Word start locations. 
    123125          Y2 = (X-SHIFT(X,-1)) EQ 1                     ; Diff=1: word end. 
    124126          Z2 = WHERE(SHIFT(Y2,1) EQ 1)                  ; Word end locations. 
    125   
     127 
    126128          txtstr0 = txtstr[0]                           ; Move string to common. 
    127129          NWDS = long(TOTAL(Y))                         ; Number of words. 
    … …  
    135137          endif 
    136138        endelse 
    137   
     139 
    138140        nwords = nwds                                   ; Set nwords 
    139   
     141 
    140142        if keyword_set(last) then begin                 ; Offset from last. 
    141143          lst = nwds - 1 
    … …  
    149151          im = im < lst                                 ;  to be last. 
    150152          ll = loc[in]                                  ; Nth word start. 
    151           return, strtrim(strmid(txtstr0,ll,loc[im]-loc[in]+len[im]), 2)  
     153          return, strtrim(strmid(txtstr0,ll,loc[im]-loc[in]+len[im]), 2) 
    152154        endif 
    153   
     155 
    154156        N = ABS(NTH)                                    ; Allow nth<0. 
    155157        IF N GT NWDS-1 THEN RETURN,''                   ; out of range, null. 
    … …  
    157159        IF NTH LT 0 THEN GOTO, NEG                      ; Handle nth<0. 
    158160        IF MTH GT NWDS-1 THEN MTH = NWDS-1              ; Words to end. 
    159   
     161 
    160162        if keyword_set(notrim) then begin 
    161163          RETURN, STRMID(TXTSTR0,ll,LOC[MTH]-LOC[NTH]+LEN[MTH]) 
    … …  
    163165          RETURN, strtrim(STRMID(TXTSTR0,ll,LOC[MTH]-LOC[NTH]+LEN[MTH]), 2) 
    164166        endelse 
    165   
     167 
    166168NEG:    if keyword_set(notrim) then begin 
    167169          RETURN, STRMID(TXTSTR0,ll,9999) 
    … …  
    169171          RETURN, strtrim(STRMID(TXTSTR0,ll,9999), 2) 
    170172        endelse 
    171   
     173 
    172174        END 

  • trunk/SRC/ToBeReviewed/TRIANGULATION/definetri.pro

    r186 r230  
    4848; 
    4949; @param DOWNWARD {in}{optional} 
    50 ; When downward is undefine all rectangles are cut in using the upward  
     50; When DOWNWARD is undefined all rectangles are cut in using the upward  
    5151; diagonal.  
    52 ; Downward is a vector which contains the rectangles numbers which are cut in  
     52; DOWNWARD is a vector which contains the rectangles numbers which are cut in  
    5353; using the downward diagonal. 
    5454; The rectangle number is defined by the index (in a nx*ny vector) of the  

  • trunk/SRC/Utilities/createpro.pro

    r229 r230  
    8888; compile it 
    8989   resolve_routine, shortfilename 
     90help,ex,/structure 
     91print,' ex = ',ex 
    9092; execute it 
    9193   call_procedure, shortfilename, _extra = ex 

  • trunk/SRC/Utilities/report.pro

    r226 r230  
    3838; @returns 
    3939; -1 if the keyword QUESTION is not activated 
    40 ; If the keyword is activated, return 1 for yes and 0 for no. 
     40; If the keyword QUESTION is activated, return 1 for yes and 0 for no. 
    4141; 
    4242; @examples 

  • trunk/SRC/Utilities/xfile.pro

    r223 r230  
    6565; we open the file in a widget 
    6666   xdisplayfile, pfile[i-1], _extra = ex 
    67    ENDIF ELSE ras = report('file does not exist ...') 
     67   ENDIF ELSE ras = report(filename + ' does not exist ...') 
    6868; 
    6969; 

  • trunk/SRC/Utilities/xhelp.pro

    r224 r230  
    9898      ENDELSE 
    9999      FREE_LUN, unit         ;free the file unit. 
    100    ENDIF ELSE ras = report('file does not exist ...') 
     100   ENDIF ELSE ras = report(filename + ' does not exist ...') 
    101101 
    102102   return 
Note: See TracChangeset for help on using the changeset viewer.