Changeset 163 for trunk/SRC/Utilities

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/Utilities

Files:

• createpro.pro (modified) (1 diff)
• find.pro (modified) (1 diff)
• fitintobox.pro (modified) (2 diffs)
• isadirectory.pro (modified) (1 diff)
• isafile.pro (modified) (1 diff)
• linearequation.pro (modified) (1 diff)
• lineintersection.pro (modified) (2 diffs)
• protype.pro (modified) (1 diff)
• report.pro (modified) (2 diffs)
• routine_name.pro (modified) (2 diffs)
• testvar.pro (modified) (1 diff)
• text_box.pro (modified) (4 diffs)
• undefine.pro (modified) (2 diffs)
• xfile.pro (modified) (1 diff)
• xhelp.pro (modified) (2 diffs)

trunk/SRC/Utilities/createpro.pro

@@ -6 +6 @@
 ; write an idl procedure, compile it and execute it.
 ;
-; @param command {in}{required} 
+; @param command {in}{required}{type=string array}
 ; a string array defining the procedure to be created. 
 ; each element will be a line of the created procedure.

trunk/SRC/Utilities/find.pro

@@ -13 +13 @@
 ; @categories find a file
 ;
-; @param filein {in}{required} 
+; @param FILEIN {in}{required} 
 ; A scalar or array variable of string type, containing
 ; file names to match. Input names specifications may contain

trunk/SRC/Utilities/fitintobox.pro

@@ -1 @@
-;------------------------------------------------------------
+ ;------------------------------------------------------------
 ;------------------------------------------------------------
 ;------------------------------------------------------------
@@ -70 +70 @@
 ; Compatibility
 ;
-; @param field {in}{required} an array or a structure that can be read by the function                
-;     litchamp.pro
+; @param field {in}{required}{type=array or struct}
+; an array or a structure that can be read by the function                
+; litchamp.pro
 ; 
 ; @param nx {in}{optional}{default=define by grille.pro}

trunk/SRC/Utilities/isadirectory.pro

@@ -9 +9 @@
 ; @categories io
 ;
-; @param directoryin {in}{optional} 
+; @param DIRECTORYIN {in}{optional} 
 ; a proposed directory. If neither dirname
 ; input parameter of IODIRECTORY keyword are defined,

trunk/SRC/Utilities/isafile.pro

@@ -9 +9 @@
 ; @categories io
 ;
-; @param filein {in}{optional} 
+; @param FILEIN {in}{optional} 
 ; a proposed name. If neither filein input parameter of filename keyword are 
 ; defined, the ask the user to choose a file.

trunk/SRC/Utilities/linearequation.pro

@@ -12 +12 @@
  ;Utilities
 ; 
-; @param point1 {in}{required} 
+; @param POINT1 {in}{required} 
 ; This is the first point of(the) straight line(s) whose we want to calculate 
 ; equation(s)
 ;
-; @param point2 {in}{required} 
+; @param POINT2 {in}{required} 
 ; This is the second point of(the) straight line(s) whose we want to calculate
 ; equation(s)

trunk/SRC/Utilities/lineintersection.pro

@@ -11 +11 @@
 ; Utilities
 ; 
-; @param abc1 {in}{required} 
-; is the first table of dimension 3, number_of_pairs_of_straight_lines, 
+; @param ABC1 {in}{required}{type=3d array}
+; is the first array of dimension 3, number_of_pairs_of_straight_lines, 
 ; whose each line contain the 3 parameters a,b and c of the first linear 
 ; equation of the type ax+by+c=0
 ;
-; @param abc2 {in}{required} 
-; is second table of dimension 3, number_of_pairs_of_straight_lines, 
+; @param ABC2 {in}{required}{type=3d array}
+; is second array of dimension 3, number_of_pairs_of_straight_lines, 
 ; whose each line contain the 3 parameters a,b and c of the second linear 
 ; equation of the type ax+by+c=0
 ;
 ; @keyword FLOAT 
-; To return the output as a table of real numbers instead of vectors of 
+; To return the output as a array of real numbers instead of vectors of 
 ; complex (by default)
 ;
@@ -29 +29 @@
 ;      1) by default: it is a vector of complex whose each element is the coordinates 
 ;                     of the intersection point of a pair of straight lines.
-;      2) if FLOAT is activated, it is a table of reals of dimension 2, 
+;      2) if FLOAT is activated, it is a array of reels of dimension 2, 
 ;         number_of_pairs_of_straight_lines whose each row is the coordinates 
 ;         of the intersection point of a pair of straight line.

trunk/SRC/Utilities/protype.pro

@@ -9 +9 @@
 ; Utilities
 ;
-; @param file {in} 
+; @param FILE {in} 
 ; A scalar of string type, the name of the ".pro" file to be tested
 ; if necessary, the input name is completed with '.pro'

trunk/SRC/Utilities/report.pro

@@ -9 +9 @@
 ; To ask a question whose answer is not yes/no,use xquestion.
 ;
-; @param text {in}{required} 
+; @param TEXT {in}{required} 
 ; one string or one vector of string. Si le string ne
 ; comporte qu''un element, on cherche les eventuels characteres de
@@ -19 +19 @@
 ; and the line of the routine (defined by calling routine_name)
 ;
-; @keyword _extra 
+; @keyword _EXTRA 
 ; used to pass keywords from dialog_message.pro and message.pro
 ;

trunk/SRC/Utilities/routine_name.pro

@@ -10 +10 @@
 ; Utilities
 ;
-; @param pilingnum {in}{optional}
+; @param PILINGNUM {in}{optional}
 ; A whole number which give us how many level we have to reascend
 ; in the piling up of routines and subroutines to find the looked for routine.
-;
 ;
 ; @returns
@@ -21 +20 @@
 ; @restrictions
 ; This function use the keyword OUTPUT in help.pro and it is specified
-; in the online help that the return syntax of this word can change in
+; in the on-line help that the return syntax of this word can change in
 ; function of the version of the code. This version works with IDL 5.2.
 ;

trunk/SRC/Utilities/testvar.pro

@@ -10 +10 @@
 ; Utilities
 ;
-; @keyword var 
+; @keyword VAR 
 ; any kind of
 ;

trunk/SRC/Utilities/text_box.pro

@@ -10 +10 @@
 ; ASCII text string containing the message.
 ;
-; @keyword pos  
+; @keyword POS  
 ; 4 element vector specifying the box position and size
 ; pos[0],pos[1] specify the lower left corner coordinate
@@ -16 +16 @@
 ; data window normalized coordinates are use
 ;
-; @keyword fg_color
-; color of box and legend titles (default=0)
+; @keyword FG_COLOR {default=0}
+; color of box and legend titles
 ;
-; @keyword bg_color 
+; @keyword BG_COLOR 
 ; background color. Setting BG_COLOR erases the area 
 ;               covered by the text box (filling it with color BG_COLOR)
@@ -26 +26 @@
 ;               gaurantee a readability.
 ;               
-; @keyword right 
+; @keyword RIGHT 
 ; if set, right justify text
 ;
-; @keyword center 
+; @keyword CENTER 
 ; if set, center the text
 ;
-; @keyword vert_space {default=1.5}
+; @keyword VERT_SPACE {default=1.5}
 ; vertical spacing of lines in units of character height
 ;
@@ -38 +38 @@
 ; used to pass your keyword
 ;
-; @keyword box 
+; @keyword BOX 
 ; activate to show the box on graphics window.
 ;

trunk/SRC/Utilities/undefine.pro

@@ -12 +12 @@
 ; Utilities  
 ; 
-; @param varname {in}{required} 
+; @param VARNAME {in}{required} 
 ; The name of the variable we want erase
 ;
@@ -37 +37 @@
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-   PRO UNDEFINE, varname  
+   PRO undefine, varname  
 ;
   compile_opt idl2, strictarrsubs

trunk/SRC/Utilities/xfile.pro

@@ -13 +13 @@
 ; Utilities
 ;
-; @param filename {in}{required} 
+; @param FILENAME {in}{required} 
 ; It is the name of the procedure or of the function 
 ; we want to display (with or without .pro at the end).
 ;
-; @keyword _extra 
+; @keyword _EXTRA 
 ; used to pass your keywords
 ;

trunk/SRC/Utilities/xhelp.pro

@@ -7 +7 @@
 ; Widget
 ;
-; @param Filename {in}{required} 
+; @param FILENAME {in}{required} 
 ; A scalar string that contains the filename of the file to display.  
 ; If FILENAME does not include a complete path specification, xhelp will 
@@ -14 +14 @@
 ; ".pro" file suffix will be appended if it is not supplied.
 ;
-; @keyword _extra 
+; @keyword _EXTRA 
 ; used to pass your keywords
 ;