Changeset 163 for trunk/SRC/ToBeReviewed/HOPE

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

Files:

• completetype.pro (modified) (1 diff)
• createhopestruct.pro (modified) (1 diff)
• cw_selectinterval.pro (modified) (1 diff)
• domainpart.pro (modified) (1 diff)
• findlineandpointtype.pro (modified) (1 diff)
• read_hope.pro (modified) (3 diffs)
• rh_alldomains.pro (modified) (1 diff)
• sortdim.pro (modified) (1 diff)
• xrh.pro (modified) (1 diff)

trunk/SRC/ToBeReviewed/HOPE/completetype.pro

@@ -1 +1 @@
 ;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param TYPEIN
+;
+;
+; @returns
+;
+;
+; @uses
+;
+;
+; @restrictions
+;
+;
+; @examples
+;
+;
+; @history
+;
+;
+; @version
+; $Id$
 ;
 ; @todo seb

trunk/SRC/ToBeReviewed/HOPE/createhopestruct.pro

@@ -1 +1 @@
 ;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param EVENT
+;
+;
+; @returns
+;
+;
+; @uses
+;
+;
+; @restrictions
+;
+;
+; @examples
+;
+;
+; @history
+;
+;
+; @version
+; $Id$
 ;
 ; @todo seb

trunk/SRC/ToBeReviewed/HOPE/cw_selectinterval.pro

@@ -152 +152 @@
 ; The widget ID of the parent widget.
 ; 
-; @param VECTEUR
+; @param VECTEUR {type=vector}
 ; A vector whose the first element must be the smallest one and the last 
 ; must be the biggest one.

trunk/SRC/ToBeReviewed/HOPE/domainpart.pro

@@ -1 +1 @@
 ;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param TOP_UVALUE
+;
+;
+; @param BASEDOMAIN
+;
+;
+; @param SELECTED
+;
+;
+; @keyword DESTROY
+;
+;
+; @returns
+;
+;
+; @uses
+;
+;
+; @restrictions
+;
+;
+; @examples
+;
+;
+; @history
+;
+;
+; @version
+; $Id$
 ;
 ; @todo seb

trunk/SRC/ToBeReviewed/HOPE/findlineandpointtype.pro

@@ -1 +1 @@
 ;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param SECTYPE
+;
+;
+; @param XAXIS
+;
+;
+; @param YAXIS
+;
+;
+; @param IODIR
+;
+;
+; @returns
+;
+;
+; @uses
+;
+;
+; @restrictions
+;
+;
+; @examples
+;
+;
+; @history
+;
+;
+; @version
+; $Id$
 ;
 ; @todo seb

trunk/SRC/ToBeReviewed/HOPE/read_hope.pro

@@ -218 +218 @@
 ; Reading
 ;
-; @param TYPEIN {in}{required}
-; A string specifing from which type of section the 4D
+; @param TYPEIN {in}{required}{type=string}
+; A string specifying from which type of section the 4D
 ; array based: 'xy, 'xz', 'yz'
 ;
-; @param VARNAMEIN
-; A string the name of the cariable to be read (in
+; @param VARNAMEIN {in}{required}{type=string}
+; A string the name of the variable to be read (in
 ; lower or upper case)
 ;
-; @keyword FILENAME
+; @keyword FILENAME {type=string}
 ; The name of the file to be read
 ;
-; @keyword XLIMITS
-; A two elements vertor [lonmin, lonmax]]
-; the bondary of the longitudes (from 0 to 360)
-;
-; @keyword YLIMITS
-; A two elements vertor [latmin, latmax]]
-; the bondary of the latitudes (from -90 to 90)
-;
-; @keyword ZLIMITS
-; A two elements vertor [depthmin, depthmax]]
-; the bondary of the depth
-;
-; @keyword TLIMITS
-; A two elements vertor [date1, date2]]
-; the bondary of the calendar with date1 and date2
-; folowing the syntaxe yyyymmdd
+; @keyword XLIMITS {type=vector}
+; A two elements vector [lonmin, lonmax]]
+; the boundary of the longitudes (from 0 to 360)
+;
+; @keyword YLIMITS {type=vector}
+; A two elements vector [latmin, latmax]]
+; the boundary of the latitudes (from -90 to 90)
+;
+; @keyword ZLIMITS {type=vector}
+; A two elements vector [depthmin, depthmax]]
+; the boundary of the depth
+;
+; @keyword TLIMITS {type=vector}
+; A two elements vector [date1, date2]]
+; the boundary of the calendar with date1 and date2
+; folowing the syntax yyyymmdd
 ;
 ; @keyword ODDPT
@@ -259 +259 @@
 ;
 ; @keyword _EXTRA
-; Used to pass yor keywords
+; Used to pass your keywords
 ;
 ; @returns
@@ -266 +266 @@
 ;
 ; A structure which but be read by litchamp.pro and is
-; necessary to complute the grid associated to the data (see
+; necessary to complete the grid associated to the data (see
 ; the example).
 ;
 ; @uses
-; common.pro (usefull only for the definition of iodir)
+; common.pro (useful only for the definition of iodir)
 ;
 ; @restrictions
 ; 'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv
-; must be able to works with this kind of fonction.
-; The grib file has no zoom possibilities on horizontal dimensions.
+; must be able to works with this kind of function.
+; The grid file has no zoom possibilities on horizontal dimensions.
 ;
 ; @restrictions
 ;
-; When typein and varnamein are defined, the methode to find the
-; godd variable is:
+; When typein and varnamein are defined, the method to find the
+; good variable is:
 ;  1) find the variables which are available on this type of
-; sections woth this name
+; sections with this name
 ;  2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only
 ; these types of sections

trunk/SRC/ToBeReviewed/HOPE/rh_alldomains.pro

@@ -1 +1 @@
 ;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param TOPID
+;
+;
+; @param SELECTED
+;
+;
+; @returns
+;
+;
+; @uses
+;
+;
+; @restrictions
+;
+;
+; @examples
+;
+;
+; @history
+;
+;
+; @version
+; $Id$
 ;
 ; @todo seb

trunk/SRC/ToBeReviewed/HOPE/sortdim.pro

@@ -1 +1 @@
 ;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param DIMS
+;
+;
+; @keyword INVERSE
+;
+;
+; @returns
+;
+;
+; @uses
+;
+;
+; @restrictions
+;
+;
+; @examples
+;
+;
+; @history
+;
+;
+; @version
+; $Id$
 ;
 ; @todo seb

trunk/SRC/ToBeReviewed/HOPE/xrh.pro

@@ -1 +1 @@
 ;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @keyword _EXTRA
+; Used to pass your keywords
+;
+; @returns
+;
+;
+; @uses
+;
+;
+; @restrictions
+;
+;
+; @examples
+;
+;
+; @history
+;
+;
+; @version
+; $Id$
 ;
 ; @todo seb