Update comments/doxygen docs

This commit is contained in:
Shahram Najm 2016-08-17 14:47:02 +01:00
parent ea44106a46
commit 5aeaf8a48b
4 changed files with 12 additions and 5 deletions

View File

@ -35,10 +35,12 @@ end subroutine codes_set_missing
!>
!> \b Examples: \ref grib_index.f90 "grib_index.f90"
!>
!> @param indexid id of the newly created index
!> @param filename name of the file of messages to be indexed
!> @param keys : comma separated list of keys for the index. The type of the key can be explicitly declared appending :l for long, :d for double, :s for string to the key name. If the type is not declared explicitly, the native type is assumed.
!> @param status CODES_SUCCESS if OK, integer value on error
!> @param indexid id of the newly created index
!> @param filename name of the file of messages to be indexed
!> @param keys comma separated list of keys for the index.
!> The type of the key can be explicitly declared appending :l for long (or alternatively :i), :d for double, :s for string to the key name.
!> If the type is not declared explicitly, the native type is assumed.
!> @param status CODES_SUCCESS if OK, integer value on error
subroutine codes_index_create ( indexid, filename, keys, status )
integer(kind=kindOfInt), intent(inout) :: indexid
character(len=*), intent(in) :: filename

View File

@ -1009,7 +1009,8 @@ def grib_index_new_from_file(filename, keys):
\b Examples: \ref grib_index.py "grib_index.py"
@param filename path of the file to index on
@param keys sequence of keys to index on
@param keys sequence of keys to index on.
The type of the key can be explicitly declared appending :l for long (or alternatively :i), :d for double, :s for string to the key name.
@return index id
@exception GribInternalError
"""

View File

@ -202,6 +202,7 @@ typedef struct grib_index codes_index;
* @param filename : name of the file of messages to be indexed
* @param keys : comma separated list of keys for the index.
* The type of the key can be explicitly declared appending :l for long,
* (or alternatively :i)
* :d for double, :s for string to the key name. If the type is not
* declared explicitly, the native type is assumed.
* @param err : 0 if OK, integer value on error
@ -215,6 +216,7 @@ codes_index* codes_index_new_from_file(codes_context* c, char* filename,const ch
* @param c : context (NULL for default context)
* @param keys : comma separated list of keys for the index.
* The type of the key can be explicitly declared appending :l for long,
* (or alternatively :i)
* :d for double, :s for string to the key name. If the type is not
* declared explicitly, the native type is assumed.
* @param err : 0 if OK, integer value on error

View File

@ -247,6 +247,7 @@ typedef struct grib_index grib_index;
* @param filename : name of the file of messages to be indexed
* @param keys : comma separated list of keys for the index.
* The type of the key can be explicitly declared appending :l for long,
* (or alternatively :i)
* :d for double, :s for string to the key name. If the type is not
* declared explicitly, the native type is assumed.
* @param err : 0 if OK, integer value on error
@ -260,6 +261,7 @@ grib_index* grib_index_new_from_file(grib_context* c,
* @param c : context (NULL for default context)
* @param keys : comma separated list of keys for the index.
* The type of the key can be explicitly declared appending :l for long,
* (or alternatively :i)
* :d for double, :s for string to the key name. If the type is not
* declared explicitly, the native type is assumed.
* @param err : 0 if OK, integer value on error