Skip to content

Commit

Permalink
added some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardhartnett committed Nov 1, 2024
1 parent 607596a commit dd4d315
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/g2cfile.c
Original file line number Diff line number Diff line change
Expand Up @@ -1174,6 +1174,17 @@ g2c_add_file(const char *path, int mode, int *g2cid)
}

/** Open an existing GRIB2 file.
*
* This function opens the GRIB2 file and reads its metadata.
*
* GRIB2 messages in the file are assigned a message ID, starting with
* 0 for the first message in the file.
*
* Each product within a message is assigned a product ID, starting
* with 0 for the first product in the message.
*
* Files opened with this function should be closed with a call
* g2c_close() to release resources.
*
* @param path Path of the file.
* @param mode Open mode flags.
Expand Down

0 comments on commit dd4d315

Please sign in to comment.