Skip to content

Commit 2798c27

Browse files
WardFWardF
authored
Merge pull request #3265 from edhartnett/test_CI
documentation fixes
2 parents 31c0d60 + 6b2c954 commit 2798c27

11 files changed

Lines changed: 201 additions & 99 deletions

File tree

‎libdispatch/dcompound.c‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ for this field.
9090
\returns ::NC_ENAMEINUSE That name is in use.
9191
\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
9292
\returns ::NC_EBADNAME Name contains illegal characters.
93-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
93+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
9494
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
9595
\returns ::NC_EPERM Attempt to write to a read-only file.
9696
\returns ::NC_ENOTINDEFINE Not in define mode.
@@ -132,7 +132,7 @@ for this field.
132132
\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
133133
\returns ::NC_EBADNAME Name contains illegal characters.
134134
\returns ::NC_ESTRICTNC3 Attempting a netCDF-4 operation on a netCDF-3 file.
135-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
135+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
136136
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
137137
\returns ::NC_EPERM Attempt to write to a read-only file.
138138
\returns ::NC_ENOTINDEFINE Not in define mode.
@@ -168,7 +168,7 @@ placed here. \ref ignored_if_null.
168168
\returns ::NC_NOERR No error.
169169
\returns ::NC_EBADID Bad \ref ncid.
170170
\returns ::NC_EBADTYPE Bad type id.
171-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
171+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
172172
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
173173
*/
174174
int
@@ -196,7 +196,7 @@ ignored_if_null.
196196
\returns ::NC_NOERR No error.
197197
\returns ::NC_EBADID Bad \ref ncid.
198198
\returns ::NC_EBADTYPE Bad type id.
199-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
199+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
200200
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
201201
*/
202202
int
@@ -219,7 +219,7 @@ ignored_if_null.
219219
\returns ::NC_NOERR No error.
220220
\returns ::NC_EBADID Bad \ref ncid.
221221
\returns ::NC_EBADTYPE Bad type id.
222-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
222+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
223223
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
224224
*/
225225
int
@@ -242,7 +242,7 @@ placed here. \ref ignored_if_null.
242242
\returns ::NC_NOERR No error.
243243
\returns ::NC_EBADID Bad \ref ncid.
244244
\returns ::NC_EBADTYPE Bad type id.
245-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
245+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
246246
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
247247
*/
248248
int
@@ -280,7 +280,7 @@ field. \ref ignored_if_null.
280280
\returns ::NC_NOERR No error.
281281
\returns ::NC_EBADID Bad \ref ncid.
282282
\returns ::NC_EBADTYPE Bad type id.
283-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
283+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
284284
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
285285
*/
286286
int
@@ -314,7 +314,7 @@ ignored_if_null.
314314
\returns ::NC_NOERR No error.
315315
\returns ::NC_EBADID Bad \ref ncid.
316316
\returns ::NC_EBADTYPE Bad type id.
317-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
317+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
318318
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
319319
*/
320320
int
@@ -346,7 +346,7 @@ ignored_if_null.
346346
\returns ::NC_NOERR No error.
347347
\returns ::NC_EBADID Bad \ref ncid.
348348
\returns ::NC_EBADTYPE Bad type id.
349-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
349+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
350350
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
351351
*/
352352
int
@@ -376,7 +376,7 @@ field. \ref ignored_if_null.
376376
\returns ::NC_NOERR No error.
377377
\returns ::NC_EBADID Bad \ref ncid.
378378
\returns ::NC_EBADTYPE Bad type id.
379-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
379+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
380380
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
381381
*/
382382
int
@@ -406,7 +406,7 @@ field. \ref ignored_if_null.
406406
\returns ::NC_NOERR No error.
407407
\returns ::NC_EBADID Bad \ref ncid.
408408
\returns ::NC_EBADTYPE Bad type id.
409-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
409+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
410410
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
411411
*/
412412
int
@@ -436,7 +436,7 @@ field. \ref ignored_if_null.
436436
\returns ::NC_NOERR No error.
437437
\returns ::NC_EBADID Bad \ref ncid.
438438
\returns ::NC_EBADTYPE Bad type id.
439-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
439+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
440440
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
441441
*/
442442
int
@@ -468,7 +468,7 @@ field. \ref ignored_if_null.
468468
\returns ::NC_NOERR No error.
469469
\returns ::NC_EBADID Bad \ref ncid.
470470
\returns ::NC_EBADTYPE Bad type id.
471-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
471+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
472472
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
473473
*/
474474
int

‎libdispatch/denum.c‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ will be placed there.
3131
\returns ::NC_NOERR No error.
3232
\returns ::NC_EBADID Bad \ref ncid.
3333
\returns ::NC_EBADTYPE Bad type id.
34-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
34+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
3535
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
3636
\returns ::NC_ENAMEINUSE That name is in use.
3737
\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
@@ -52,14 +52,14 @@ nc_def_enum(int ncid, nc_type base_typeid, const char *name, nc_type *typeidp)
5252
Insert a named member into a enum type.
5353
5454
\param ncid \ref ncid
55-
\param xtype
55+
\param xtype Typeid of the enum type.
5656
\param name The identifier (\ref object_name) of the new member.
5757
\param value The value that is to be associated with this member.
5858
5959
\returns ::NC_NOERR No error.
6060
\returns ::NC_EBADID Bad \ref ncid.
6161
\returns ::NC_EBADTYPE Bad type id.
62-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
62+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
6363
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
6464
\returns ::NC_ENAMEINUSE That name is in use.
6565
\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
@@ -79,7 +79,7 @@ nc_insert_enum(int ncid, nc_type xtype, const char *name,
7979
}
8080

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

118118
/** \ingroup user_types
119-
Learn about a about a member of an enum type.
119+
Learn about a member of an enum type.
120120
121121
\param ncid \ref ncid
122122
@@ -133,7 +133,7 @@ ignored_if_null.
133133
\returns ::NC_NOERR No error.
134134
\returns ::NC_EBADID Bad \ref ncid.
135135
\returns ::NC_EBADTYPE Bad type id.
136-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
136+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
137137
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
138138
*/
139139
int
@@ -149,15 +149,15 @@ nc_inq_enum_member(int ncid, nc_type xtype, int idx, char *name,
149149
/** \ingroup user_types
150150
Get the name which is associated with an enum member value.
151151
152-
\param ncid
152+
\param ncid \ref ncid
153153
\param xtype Typeid of the enum type.
154154
\param value Value of interest.
155155
\param identifier The identifier (\ref object_name) of this value will be copied here; ignored_if_null.
156156
157157
\returns ::NC_NOERR No error.
158158
\returns ::NC_EBADID Bad \ref ncid.
159159
\returns ::NC_EBADTYPE Bad type id.
160-
\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
160+
\returns ::NC_ENOTNC4 Not a netCDF-4 file, or classic model enabled.
161161
\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
162162
*/
163163
int

‎libdispatch/dfilter.c‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ nc_inq_var_filter_ids(int ncid, int varid, size_t* nfiltersp, unsigned int* ids)
6969
}
7070

7171
/**
72-
Find the the param info about filter (if any)
72+
Find the param info about filter (if any)
7373
associated with a variable and with specified id.
7474
Assumes HDF5 format using unsigned ints.
7575
@@ -230,7 +230,9 @@ nc_inq_filter_avail(int ncid, unsigned id)
230230
* when compressing. (bzip2 default level is 9).
231231
*
232232
* @return 0 for success, error code otherwise.
233+
* @since 4.9.0
233234
* @author Dennis Heimbigner, Ed Hartnett
235+
* @ingroup variables
234236
*/
235237
int
236238
nc_def_var_bzip2(int ncid, int varid, int level)
@@ -261,7 +263,9 @@ nc_def_var_bzip2(int ncid, int varid, int level)
261263
* bzip2 is in use. Ignored if NULL.
262264
*
263265
* @return 0 for success, error code otherwise.
266+
* @since 4.9.0
264267
* @author Dennis Heimbigner, Ed Hartnett
268+
* @ingroup variables
265269
*/
266270
int
267271
nc_inq_var_bzip2(int ncid, int varid, int* hasfilterp, int *levelp)
@@ -298,7 +302,9 @@ nc_inq_var_bzip2(int ncid, int varid, int* hasfilterp, int *levelp)
298302
* The lower the level, the faster the speed (at the cost of compression).
299303
*
300304
* @return 0 for success, error code otherwise.
305+
* @since 4.9.0
301306
* @author Charlie Zender, Dennis Heimbigner, Ed Hartnett
307+
* @ingroup variables
302308
*/
303309
int
304310
nc_def_var_zstandard(int ncid, int varid, int level)
@@ -334,7 +340,9 @@ nc_def_var_zstandard(int ncid, int varid, int level)
334340
* Zstandard is in use. Ignored if NULL.
335341
*
336342
* @return 0 for success, error code otherwise.
343+
* @since 4.9.0
337344
* @author Charlie Zender, Dennis Heimbigner, Ed Hartnett
345+
* @ingroup variables
338346
*/
339347
int
340348
nc_inq_var_zstandard(int ncid, int varid, int* hasfilterp, int *levelp)
@@ -374,6 +382,7 @@ nc_inq_var_zstandard(int ncid, int varid, int* hasfilterp, int *levelp)
374382
* @param addshuffle If non-zero, turn on shuffle.
375383
*
376384
* @return 0 for success, error code otherwise.
385+
* @since 4.9.0
377386
* @author Dennis Heimbigner
378387
* @ingroup variables
379388
*/
@@ -425,7 +434,9 @@ nc_def_var_blosc(int ncid, int varid, unsigned subcompressor, unsigned level, un
425434
* in use, if blosc is in use. Ignored if NULL.
426435
*
427436
* @return 0 for success, error code otherwise.
437+
* @since 4.9.0
428438
* @author Dennis Heimbigner
439+
* @ingroup variables
429440
*/
430441
int
431442
nc_inq_var_blosc(int ncid, int varid, int* hasfilterp, unsigned* subcompressorp,

0 commit comments

Comments
 (0)
⚡