mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2025-01-18 15:55:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

fixed doxygen warnings in RELEASE_NOTES.md

Browse Source
This commit is contained in:
Ed Hartnett 2019-02-25 07:16:47 -07:00
parent 3997511379
commit 05d549e900
2 changed files with 32 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
RELEASE_NOTES.md
View File

@ -13,7 +13,7 @@ This file contains a high-level description of this package's evolution. Release
* Update the license from the home-brewed NetCDF license to the standard 3-Clause BSD License. This change does not result in any new restrictions; it is merely the adoption of a standard, well-known and well-understood license in place of the historic NetCDF license written at Unidata. This is part of a broader push by Unidata to adopt modern, standardized licensing.
* [BugFix] Corrected DAP-releated issues on big-endian machines. See [Github #1321](https://github.com/Unidata/netcdf-c/issues/1321), [Github #1302](https://github.com/Unidata/netcdf-c/issues/1302) for more information.
* [BugFix][Enhancement] Various and sundry bugfixes and performance enhancements, thanks to @edhartnett, @gsjaardema, @t-b, @wkliao, and all of our other contributors.
* [BugFix][Enhancement] Various and sundry bugfixes and performance enhancements, thanks to \@edhartnett, \@gsjaardema, \@t-b, \@wkliao, and all of our other contributors.
* [Enhancement] Extended `nccopy -F` syntax to support multiple variables with a single invocation. See [Github #1311](https://github.com/Unidata/netcdf-c/issues/1311) for more information.
* [BugFix] Corrected an issue where DAP2 was incorrectly converting signed bytes, resulting in an erroneous error message under some circumstances. See [GitHub #1317](https://github.com/Unidata/netcdf-c/issues/1317) for more information. See [Github #1319](https://github.com/Unidata/netcdf-c/issues/1319) for related information.
* [BugFix][Enhancement] Modified `nccopy` so that `_NCProperties` is not copied over verbatim but is instead generated based on the version of `libnetcdf` used when copying the file. Additionally, `_NCProperties` are displayed if/when associated with a netcdf3 file, now. See [GitHub #803](https://github.com/Unidata/netcdf-c/issues/803) for more information.

61
libdispatch/ddim.c
View File

@ -14,45 +14,46 @@
Dimensions are used to define the shape of data in netCDF.
Dimensions for a netCDF dataset are defined when it is created, while
the netCDF dataset is in define mode. Additional dimensions may be
added later by reentering define mode. A netCDF dimension has a name
and a length. In a netCDF classic or 64-bit offset file, at most one
dimension can have the unlimited length, which means variables using
this dimension can grow along this dimension. In a netCDF-4 file
multiple unlimited dimensions are supported.
Dimensions for a netCDF dataset are defined when it is created,
while the netCDF dataset is in define mode. Additional dimensions
may be added later by reentering define mode. A netCDF dimension
has a name and a length. In a netCDF classic or 64-bit offset file,
at most one dimension can have the unlimited length, which means
variables using this dimension can grow along this dimension. In a
netCDF-4 file multiple unlimited dimensions are supported.
There is a suggested limit (1024) to the number of dimensions that can
be defined in a single netCDF dataset. The limit is the value of the
predefined macro NC_MAX_DIMS. The purpose of the limit is to make
writing generic applications simpler. They need only provide an array
of NC_MAX_DIMS dimensions to handle any netCDF dataset. The
implementation of the netCDF library does not enforce this advisory
maximum, so it is possible to use more dimensions, if necessary, but
netCDF utilities that assume the advisory maximums may not be able to
handle the resulting netCDF datasets.
There is a suggested limit (1024) to the number of dimensions that
can be defined in a single netCDF dataset. The limit is the value
of the predefined macro NC_MAX_DIMS. The purpose of the limit is to
make writing generic applications simpler. They need only provide
an array of NC_MAX_DIMS dimensions to handle any netCDF
dataset. The implementation of the netCDF library does not enforce
this advisory maximum, so it is possible to use more dimensions, if
necessary, but netCDF utilities that assume the advisory maximums
may not be able to handle the resulting netCDF datasets.
NC_MAX_VAR_DIMS, which must not exceed NC_MAX_DIMS, is the maximum
number of dimensions that can be used to specify the shape of a single
variable. It is also intended to simplify writing generic
number of dimensions that can be used to specify the shape of a
single variable. It is also intended to simplify writing generic
applications.
Ordinarily, the name and length of a dimension are fixed when the
dimension is first defined. The name may be changed later, but the
length of a dimension (other than the unlimited dimension) cannot be
changed without copying all the data to a new netCDF dataset with a
redefined dimension length.
length of a dimension (other than the unlimited dimension) cannot
be changed without copying all the data to a new netCDF dataset
with a redefined dimension length.
Dimension lengths in the C interface are type size_t rather than type
int to make it possible to access all the data in a netCDF dataset on
a platform that only supports a 16-bit int data type, for example
MSDOS. If dimension lengths were type int instead, it would not be
possible to access data from variables with a dimension length greater
than a 16-bit int can accommodate.
Dimension lengths in the C interface are type size_t rather than
type int to make it possible to access all the data in a netCDF
dataset on a platform that only supports a 16-bit int data type,
for example MSDOS. If dimension lengths were type int instead, it
would not be possible to access data from variables with a
dimension length greater than a 16-bit int can accommodate.
A netCDF dimension in an open netCDF dataset is referred to by a small
integer called a dimension ID. In the C interface, dimension IDs are
0, 1, 2, ..., in the order in which the dimensions were defined.
A netCDF dimension in an open netCDF dataset is referred to by a
small integer called a dimension ID. In the C interface, dimension
IDs are 0, 1, 2, ..., in the order in which the dimensions were
defined.
Operations supported on dimensions are:
- Create a dimension, given its name and length.