Changeset 318 for trunk


Ignore:
Timestamp:
12/03/07 15:21:21 (16 years ago)
Author:
smasson
Message:

header cleaning

Location:
trunk/SRC
Files:
15 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Calendar/caldat.pro

    r292 r318  
    33; @file_comments 
    44; Return the calendar date and time given julian date. 
    5 ; This is the inverse of the function 
    6 ; <pro>julday</pro>. 
     5; This is the inverse of the function <pro>julday</pro>. 
    76; 3 calendars are available according to the value of key_caltype 
    87; (variable of the common file cm_4cal): 'greg', '360d', 'noleap' 
    … …  
    1110; Calendar 
    1211; 
    13 ; @param JULIAN {in}{required} {type=long integer} 
     12; @param JULIAN {in}{required} {type=long integer or double-precision floating-point} 
    1413; contains the Julian Day Number (which begins at noon) of the 
    1514; specified calendar date. 
    1615; 
    17 ; @param MONTH {out} {type=integer} 
     16; @param MONTH {out} {type=longword integer} 
    1817; Number of the desired month (1 = January, ..., 12 = December). 
    1918; 
    20 ; @param DAY {out} {type=integer} 
     19; @param DAY {out} {type=longword integer} 
    2120; Number of day of the month. 
    2221; 
    23 ; @param YEAR {out} {type=integer} 
     22; @param YEAR {out} {type=longword integer} 
    2423; Number of the desired year. 
    2524; 
    26 ; @param HOUR {out} {type=integer} 
     25; @param HOUR {out} {type=longword integer} 
    2726; Hour of the day 
    2827; 
    29 ; @param MINUTE {out} {type=integer} 
     28; @param MINUTE {out} {type=longword integer} 
    3029; Minute of the day 
    3130; 
    32 ; @param SECOND {out} {type=float} 
     31; @param SECOND {out} {type=double-precision floating-point} 
    3332; Second (and fractions) of the day. 
    3433; 

  • trunk/SRC/Calendar/date2jul.pro

    r279 r318  
    22; 
    33; @file_comments 
    4 ; gives Julian day equivalent of a date in yyyymmdd format 
     4; gives Julian day equivalent of a date given in yyyymmdd format 
     5; This is the inverse of the function <pro>jul2date</pro>. 
    56; 
    67; @categories 
    78; Calendar 
    89; 
    9 ; @param date {in}{required} {type=long or double, sacalr or array} 
     10; @param date {in}{required} {type=long or double, scalar or array} 
    1011; longword integer with yyyymmdd format or double-precision 
    1112; floating-point with yyyymmdd.xx where xx is the fraction of the day 

  • trunk/SRC/Calendar/date2string.pro

    r238 r318  
    1111; 
    1212; @keyword _EXTRA 
    13 ; Used to pass keywords 
     13; Used to pass keywords to <proidl>string</proidl> function 
    1414; 
    1515; @returns 

  • trunk/SRC/Calendar/daysinmonth.pro

    r238 r318  
    77; Calendar 
    88; 
     9; @param MONTH {in}{optional} {type=integer} 
     10; month number 
     11; 
    912; @param YEAR {in}{optional} {default=from "time" common variable of cm_4cal} 
    1013; To specify the year of the month. Used only if the common variable 
    1114; key_caltype = 'greg'. In that case, month and year must have the same 
    1215; number of elements. 
    13 ; 
    14 ; @param MONTH {in}{optional} {type=integer} 
    15 ; month number 
    1616; 
    1717; @returns 

  • trunk/SRC/Calendar/jul2date.pro

    r279 r318  
    33; @file_comments 
    44; gives yyyymmdd date equivalent of a Julian day 
     5; This is the inverse of the function <pro>date2jul</pro>. 
    56; 
    67; @categories 
    78; Calendar 
    89; 
    9 ; @param jday {in}{required} {type=long or double, sacalr or array} 
     10; @param jday {in}{required} {type=long or double, scalar or array} 
    1011; Julian day 
    1112; 

  • trunk/SRC/Calendar/julday.pro

    r297 r318  
    33; @file_comments 
    44; Calculate the Julian Day Number for a given month, day, and year. 
    5 ; This is the inverse of the library function 
    6 ; <pro>caldat</pro>. 
     5; This is the inverse of the library function <pro>caldat</pro>. 
    76; 3 calendars are available according to the value of key_caltype 
    87; (variable of the common file cm_4cal): 'greg', '360d', 'noleap' 

  • trunk/SRC/Calendar/monthname.pro

    r231 r318  
    1111; 
    1212; @keyword _EXTRA 
    13 ; Used to pass keywords 
     13; Used to pass keywords to <proidl>string</proidl> function 
    1414; 
    1515; @returns 
    … …  
    1717; 
    1818; @examples 
    19 ; IDL> name=monthname(2) 
     19;   IDL> print, monthname([2,3]) 
     20;   February March 
     21;   IDL> print, monthname(2, format='(C(CMOA0))') 
     22;   FEBRUARY 
     23;   IDL> print, monthname(2, format='(C(CmoA03,":"))') 
     24;   feb 
    2025; 
    2126; @history 

  • trunk/SRC/Colors/color24.pro

    r258 r318  
    55; into the equivalent 24-big long integer. 
    66; This routine was written to be used with routines like 
    7 ; COLORS <!--++ COLORS is not a routine--> or 
    8 ; <pro>getcolor</pro>. 
     7; or <pro>getcolor</pro>. 
    98; 
    109; @categories 
    1110; Graphics, Color 
    1211; 
    13 ; @param rgb_triple {in}{required} 
    14 ; A three-element column or row array representing 
    15 ; a color triple. The values of the elements must be between 0 and 255. 
     12; @param rgb_triple {in}{required}{type=byte, A three-element array} 
     13; A color triple. The values of the elements must be between 0 and 255. 
    1614; 
    17 ; @returns 
     15; @returns {type=long integer} 
    1816; a 24-bit long integer that is equivalent the input color. 
    1917; The color is described in terms of a hexadecimal number (e.g., FF206A) 

  • trunk/SRC/Colors/colorbar.pro

    r231 r318  
    66; 
    77; @categories 
    8 ; Graphics, Widget 
     8; Graphics 
    99; 
    1010; @keyword BOTTOM {default=0B} 

  • trunk/SRC/ForOldVersion/oldcm_empty.pro

    r238 r318  
    11;+ 
     2; @file_comments 
     3; For internal use of SAXO 
     4; define empty common related to the obsolete variables 
     5; 
     6; @categories 
     7; Compatibility 
    28; 
    39; @history 

  • trunk/SRC/ForOldVersion/oldcm_full.pro

    r238 r318  
    11;+ 
     2; @file_comments 
     3; For internal use of SAXO 
     4; define common related to the obsolete variables 
     5; 
     6; @categories 
     7; Compatibility 
    28; 
    39; @history 

  • trunk/SRC/ForOldVersion/updatekwd.pro

    r238 r318  
    22; 
    33; @file_comments 
     4; For internal use of SAXO 
    45; compatibility with old keywords 
    56; if needed, force the definition of new keywords with the old ones. 
    67; 
    7 ; @categories compatibility with previous version 
     8; @categories 
     9; Compatibility 
    810; 
    911; @examples 
    10 ; IDL> \@updatekwd 
     12; IDL> @updatekwd 
    1113;   (must be insert as an include in a procedure or function) 
    1214; 

  • trunk/SRC/ForOldVersion/updatenew.pro

    r238 r318  
    22; 
    33; @file_comments 
    4 ; common declaration 
     4; For internal use of SAXO 
     5; common declaration: update new variables with old ones 
    56; 
    67; check that key_forgetold and keep_compatibility are well defined... 
     8; 
     9; @categories 
     10; Compatibility 
    711; 
    812; @history 

  • trunk/SRC/ForOldVersion/updateold.pro

    r238 r318  
    22; 
    33; @file_comments 
     4; For internal use of SAXO 
     5; common declaration: update old variables with new ones 
     6; 
    47; check that key_forgetold and keep_compatibility are well defined... 
     8; 
     9; @categories 
     10; Compatibility 
    511; 
    612; @history 

  • trunk/SRC/Matrix/zero_one.pro

    r237 r318  
    44; 
    55; @categories 
    6 ; Function, Matrix 
     6; Matrix 
    77; 
    88; @param n1 {in}{required} 
Note: See TracChangeset for help on using the changeset viewer.