More cleaning up of documentation (there will probably be a lot of this) and tweaking files so that documentation renders as expected.

This commit is contained in:
Ward Fisher 2016-01-14 16:02:00 -07:00
parent 30e1cca0d0
commit 374a8f4193
4 changed files with 18 additions and 56 deletions

View File

@ -350,7 +350,7 @@ SUBGROUPING = YES
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
INLINE_GROUPED_CLASSES = YES
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
@ -360,7 +360,7 @@ INLINE_GROUPED_CLASSES = NO
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
INLINE_SIMPLE_STRUCTS = YES
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
@ -424,7 +424,7 @@ EXTRACT_STATIC = YES
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_CLASSES = NO
# This flag is only useful for Objective-C code. When set to YES local methods,
# which are defined in the implementation section but not in the interface are
@ -1061,7 +1061,7 @@ VERBATIM_HEADERS = YES
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
ALPHABETICAL_INDEX = NO
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.

View File

@ -1,4 +1,7 @@
/* \file netcdf_mem.h
/*! \file netcdf_mem.h
*
* Main header file for in-memory (diskless) functionality.
*
* Copyright 2010 University Corporation for Atmospheric
* Research/Unidata. See COPYRIGHT file for more info.
*
@ -27,53 +30,7 @@ extern "C" {
# define EXTERNL MSC_EXTRA extern
/**
Open a netCDF file with the contents taken from a block of memory.
\param path Must be non-null, but otherwise only used to set the dataset name.
\param mode the mode flags; Note that this procedure uses a limited set of flags because it forcibly sets NC_NOWRITE|NC_DISKLESS|NC_INMEMORY.
\param size The length of the block of memory being passed.
\param memory Pointer to the block of memory containing the contents
of a netcdf file.
\param ncidp Pointer to location where returned netCDF ID is to be
stored.
\returns ::NC_NOERR No error.
\returns ::NC_ENOMEM Out of memory.
\returns ::NC_EDISKLESS diskless io is not enabled for fails.
\returns ::NC_EINVAL, etc. other errors also returned by nc_open.
<h1>Examples</h1>
Here is an example using nc_open_mem() to open an existing netCDF dataset
named foo.nc for read-only, non-shared access. It differs from the nc_open()
example in that it assumes the contents of foo.nc have been read into memory.
@code
#include <netcdf.h>
#include <netcdf_mem.h>
...
int status = NC_NOERR;
int ncid;
size_t size;
void* memory;
...
size = <compute file size of foo.nc in bytes>;
memory = malloc(size);
...
status = nc_open_mem("foo.nc", 0, size, memory, &ncid);
if (status != NC_NOERR) handle_error(status);
@endcode
*/
EXTERNL int
nc_open_mem(const char* path, int mode, size_t size, void* memory, int* ncidp);
EXTERNL int nc_open_mem(const char* path, int mode, size_t size, void* memory, int* ncidp);
#if defined(__cplusplus)
}

View File

@ -8,7 +8,7 @@ Research/Unidata. See COPYRIGHT file for more info.
#include "config.h"
#include "ncdispatch.h"
/** \ingroup datasets
/**
This function creates a file for use with parallel I/O.
@ -63,7 +63,11 @@ nc_open_par(const char *path, int mode, MPI_Comm comm,
#endif /* USE_PARALLEL */
}
/* Fortran needs to pass MPI comm/info as integers. */
/*! \ingroup datasets
Fortran needs to pass MPI comm/info as integers.
*/
int
nc_open_par_fortran(const char *path, int mode, int comm,
int info, int *ncidp)

View File

@ -11,9 +11,10 @@ Research/Unidata. See \ref copyright file for more info.
#undef VARS_USES_VARM
#ifndef VARS_USES_VARM
/*! \internal
/*!
\internal
*/
*/
struct GETodometer {
int rank;
size_t index[NC_MAX_VAR_DIMS];