Skip to content

documentation fixes #3265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WardF merged 4 commits into from
Mar 10, 2026
Merged

documentation fixes #3265

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c015d67
documentation fixes
edhartnett Feb 18, 2026
079e900
more ingroups
edhartnett Feb 18, 2026
363467a
Merge branch 'Unidata:main' into test_CI
edhartnett Mar 9, 2026
6b2c954
Update documentation section headers in dvarinq.c
WardF Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions libdispatch/dcompound.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ for this field.
\returns ::NC_ENAMEINUSE That name is in use.
\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
\returns ::NC_EBADNAME Name contains illegal characters.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
\returns ::NC_EPERM Attempt to write to a read-only file.
\returns ::NC_ENOTINDEFINE Not in define mode.
Expand Down Expand Up @@ -132,7 +132,7 @@ for this field.
\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
\returns ::NC_EBADNAME Name contains illegal characters.
\returns ::NC_ESTRICTNC3 Attempting a netCDF-4 operation on a netCDF-3 file.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
\returns ::NC_EPERM Attempt to write to a read-only file.
\returns ::NC_ENOTINDEFINE Not in define mode.
Expand Down Expand Up @@ -168,7 +168,7 @@ placed here. \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down Expand Up @@ -196,7 +196,7 @@ ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand All @@ -219,7 +219,7 @@ ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand All @@ -242,7 +242,7 @@ placed here. \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down Expand Up @@ -280,7 +280,7 @@ field. \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down Expand Up @@ -314,7 +314,7 @@ ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down Expand Up @@ -346,7 +346,7 @@ ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down Expand Up @@ -376,7 +376,7 @@ field. \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down Expand Up @@ -406,7 +406,7 @@ field. \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down Expand Up @@ -436,7 +436,7 @@ field. \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down Expand Up @@ -468,7 +468,7 @@ field. \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down
18 changes: 9 additions & 9 deletions libdispatch/denum.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ will be placed there.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
\returns ::NC_ENAMEINUSE That name is in use.
\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
Expand All @@ -52,14 +52,14 @@ nc_def_enum(int ncid, nc_type base_typeid, const char *name, nc_type *typeidp)
Insert a named member into a enum type.
\param ncid \ref ncid
\param xtype
\param xtype Typeid of the enum type.
\param name The identifier (\ref object_name) of the new member.
\param value The value that is to be associated with this member.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
\returns ::NC_ENAMEINUSE That name is in use.
\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
Expand All @@ -79,7 +79,7 @@ nc_insert_enum(int ncid, nc_type xtype, const char *name,
}

/** \ingroup user_types
Learn about a user-define enumeration type.
Learn about a user-defined enumeration type.
\param ncid \ref ncid
Expand All @@ -100,7 +100,7 @@ defined for this enum type. \ref ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand All @@ -116,7 +116,7 @@ nc_inq_enum(int ncid, nc_type xtype, char *name, nc_type *base_nc_typep,
}

/** \ingroup user_types
Learn about a about a member of an enum type.
Learn about a member of an enum type.
\param ncid \ref ncid
Expand All @@ -133,7 +133,7 @@ ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand All @@ -149,15 +149,15 @@ nc_inq_enum_member(int ncid, nc_type xtype, int idx, char *name,
/** \ingroup user_types
Get the name which is associated with an enum member value.
\param ncid
\param ncid \ref ncid
\param xtype Typeid of the enum type.
\param value Value of interest.
\param identifier The identifier (\ref object_name) of this value will be copied here; ignored_if_null.
\returns ::NC_NOERR No error.
\returns ::NC_EBADID Bad \ref ncid.
\returns ::NC_EBADTYPE Bad type id.
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
*/
int
Expand Down
13 changes: 12 additions & 1 deletion libdispatch/dfilter.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ nc_inq_var_filter_ids(int ncid, int varid, size_t* nfiltersp, unsigned int* ids)
}

/**
Find the the param info about filter (if any)
Find the param info about filter (if any)
associated with a variable and with specified id.
Assumes HDF5 format using unsigned ints.

Expand Down Expand Up @@ -230,7 +230,9 @@ nc_inq_filter_avail(int ncid, unsigned id)
* when compressing. (bzip2 default level is 9).
*
* @return 0 for success, error code otherwise.
* @since 4.9.0
* @author Dennis Heimbigner, Ed Hartnett
* @ingroup variables
*/
int
nc_def_var_bzip2(int ncid, int varid, int level)
Expand Down Expand Up @@ -261,7 +263,9 @@ nc_def_var_bzip2(int ncid, int varid, int level)
* bzip2 is in use. Ignored if NULL.
*
* @return 0 for success, error code otherwise.
* @since 4.9.0
* @author Dennis Heimbigner, Ed Hartnett
* @ingroup variables
*/
int
nc_inq_var_bzip2(int ncid, int varid, int* hasfilterp, int *levelp)
Expand Down Expand Up @@ -298,7 +302,9 @@ nc_inq_var_bzip2(int ncid, int varid, int* hasfilterp, int *levelp)
* The lower the level, the faster the speed (at the cost of compression).
*
* @return 0 for success, error code otherwise.
* @since 4.9.0
* @author Charlie Zender, Dennis Heimbigner, Ed Hartnett
* @ingroup variables
*/
int
nc_def_var_zstandard(int ncid, int varid, int level)
Expand Down Expand Up @@ -334,7 +340,9 @@ nc_def_var_zstandard(int ncid, int varid, int level)
* Zstandard is in use. Ignored if NULL.
*
* @return 0 for success, error code otherwise.
* @since 4.9.0
* @author Charlie Zender, Dennis Heimbigner, Ed Hartnett
* @ingroup variables
*/
int
nc_inq_var_zstandard(int ncid, int varid, int* hasfilterp, int *levelp)
Expand Down Expand Up @@ -374,6 +382,7 @@ nc_inq_var_zstandard(int ncid, int varid, int* hasfilterp, int *levelp)
* @param addshuffle If non-zero, turn on shuffle.
*
* @return 0 for success, error code otherwise.
* @since 4.9.0
* @author Dennis Heimbigner
* @ingroup variables
*/
Expand Down Expand Up @@ -425,7 +434,9 @@ nc_def_var_blosc(int ncid, int varid, unsigned subcompressor, unsigned level, un
* in use, if blosc is in use. Ignored if NULL.
*
* @return 0 for success, error code otherwise.
* @since 4.9.0
* @author Dennis Heimbigner
* @ingroup variables
*/
int
nc_inq_var_blosc(int ncid, int varid, int* hasfilterp, unsigned* subcompressorp,
Expand Down
Loading
Loading
⚡