From ad878fd669e1b83638185126b500748e33090c41 Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Tue, 4 Mar 2014 14:27:58 -0700 Subject: [PATCH 1/8] Initial split of Guide from rest of documentation. Using 'tagfiles' to cross-reference from one documentation set to the other works, but then it drags all of the 'external' related pages into the index of the other. --- man4/Doxyfile.guide.in | 6 +- man4/Doxyfile.in | 5 +- man4/guide.dox | 204 +++++++++++++++++++---------------------- 3 files changed, 99 insertions(+), 116 deletions(-) diff --git a/man4/Doxyfile.guide.in b/man4/Doxyfile.guide.in index d9ec72c61..b173f18ea 100644 --- a/man4/Doxyfile.guide.in +++ b/man4/Doxyfile.guide.in @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = NetCDF +PROJECT_NAME = "The NetCDF User's Guide" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -2003,13 +2003,13 @@ SKIP_FUNCTION_MACROS = YES # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = @CMAKE_CURRENT_BINARY_DIR@/main.tag=../ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = +GENERATE_TAGFILE = @CMAKE_CURRENT_BINARY_DIR@/guide.tag # If the ALLEXTERNALS tag is set to YES all external class will be listed in the # class index. If set to NO only the inherited external classes will be listed. diff --git a/man4/Doxyfile.in b/man4/Doxyfile.in index 5b91ef674..0f556d7eb 100644 --- a/man4/Doxyfile.in +++ b/man4/Doxyfile.in @@ -749,7 +749,6 @@ INPUT = \ @abs_top_srcdir@/man4/mainpage.dox \ @abs_top_srcdir@/man4/install.md \ @abs_top_srcdir@/man4/dispatch.dox \ - @abs_top_srcdir@/man4/guide.dox \ @abs_top_srcdir@/man4/types.dox \ @abs_top_srcdir@/man4/notes.dox \ @abs_top_srcdir@/man4/cdl.dox \ @@ -2051,13 +2050,13 @@ SKIP_FUNCTION_MACROS = YES # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = @CMAKE_CURRENT_BINARY_DIR@/guide.tag=html_guide/ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = +GENERATE_TAGFILE = @CMAKE_CURRENT_BINARY_DIR@/main.tag # If the ALLEXTERNALS tag is set to YES all external class will be listed in the # class index. If set to NO only the inherited external classes will be listed. diff --git a/man4/guide.dox b/man4/guide.dox index 6723dfc10..80be8c870 100644 --- a/man4/guide.dox +++ b/man4/guide.dox @@ -1,12 +1,18 @@ -/*! \file +/*! \file guide.dox The NetCDF User's Guide -NetCDF Users Guide +\brief The NetCDF User's Guide -The NetCDF Users Guide +\mainpage -\page user_guide The NetCDF Users Guide +\section user_guide The NetCDF User's Guide -\tableofcontents +- \subpage netcdf_summary +- \subpage netcdf_introduction +- \subpage file_structure_and_performance +- \subpage netcdf_data_set_components +- \subpage netcdf_perf_chunking +- \subpage netcdf_utilities_guide +- \subpage file_format_specifications Data - \ref external_types @@ -17,46 +23,9 @@ Data - \ref remote_client - \ref type_conversion -File Structure and Performance -- \ref classic_file_parts -- \ref parts_of_netcdf4 -- \ref xdr_layer -- \ref large_file_support -- \ref offset_format_limitations -- \ref classic_format_limitations -- \ref netcdf_3_io -- \ref parallel_access -- \ref interoperability_with_hdf5 -- \ref creating_self -- \ref dap_support +\page netcdf_summary NetCDF Summary -Improving Performance with Chunking -- \ref chunk_cache -- \ref default_chunking_4_1 -- default_chunking_4_0_1 -- \ref chunking_parallel_io -- \ref bm_file - -NetCDF Utilities -- \ref cdl_syntax -- \ref cdl_data_types -- \ref cdl_constants -- \ref guide_ncgen -- \ref guide_ncdump -- \ref guide_nccopy -- \ref guide_ncgen3 - -File Format Specification -- \ref classic_format_spec -- \ref computing_offsets -- \ref offset_examples -- \ref offset_format_spec -- \ref netcdf_4_spec -- \ref netcdf_4_classic_spec -- \ref hdf4_sd_format - - -\section netcdf_summary Summary +\tableofcontents The purpose of the Network Common Data Form (netCDF) interface is to allow you to create, access, and share array-oriented data in a form @@ -97,9 +66,11 @@ software that works with netCDF data. Separate documentation of the Java netCDF library can be found at http://www.unidata.ucar.edu/software/netcdf-java. -\section netcdf_introduction An Introduction to NetCDF +\page netcdf_introduction An Introduction to NetCDF -\subsection netcdf_interface The NetCDF Interface +\tableofcontents + +\section netcdf_interface The NetCDF Interface The Network Common Data Form, or netCDF, is an interface to a library of data access functions for storing and retrieving data in the form @@ -149,7 +120,7 @@ its widespread use. For detailed installation instructions, see Building NetCDF. -\subsection netcdf_format The netCDF File Format +\section netcdf_format The netCDF File Format Until version 3.6.0, all versions of netCDF employed only one binary data format, now referred to as netCDF classic format. NetCDF classic @@ -189,7 +160,7 @@ using the format specification to develop independent low-level software for reading and writing netCDF files, because this could lead to compatibility problems if the format is ever modified. -\subsubsection select_format How to Select the Format +\subsection select_format How to Select the Format With three different base formats, care must be taken in creating data files to choose the correct base format. @@ -217,7 +188,7 @@ It is also possible to change the default creation format, to convert a large body of code without changing every create call. C programmers see nc_set_default_format. Fortran programs see NF_SET_DEFAULT_FORMAT. -\subsubsection classic_format NetCDF Classic Format +\subsection classic_format NetCDF Classic Format The original netCDF format is identified using four bytes in the file header. All files in this format have “CDF\001” at the beginning of @@ -243,7 +214,7 @@ beginning of the file. In this documentation this format is called Since 64-bit offset format was introduced in version 3.6.0, earlier versions of the netCDF library can't read 64-bit offset files. -\subsubsection netcdf_4_format NetCDF-4 Format +\subsection netcdf_4_format NetCDF-4 Format In version 4.0, netCDF included another new underlying format: HDF5. @@ -266,7 +237,7 @@ better). For more discussion of format issues see The NetCDF Tutorial. -\subsection performance What about Performance? +\section performance What about Performance? One of the goals of netCDF is to support efficient access to small subsets of large datasets. To support this goal, netCDF uses direct @@ -295,7 +266,7 @@ operations, less so in data access operations. We continue to study the challenge of implementing netCDF-4/HDF5 format without compromising performance. -\subsection creating_self Creating Self-Describing Data conforming to Conventions +\section creating_self Creating Self-Describing Data conforming to Conventions The mere use of netCDF is not sufficient to make data "self-describing" and meaningful to both humans and machines. The @@ -319,7 +290,7 @@ conventions are often needed for local use. These should be contributed to the above netCDF conventions site if likely to interest other users in similar areas. -\subsection limitations Limitations of NetCDF +\section limitations Limitations of NetCDF The netCDF classic data model is widely applicable to data that can be organized into a collection of named array variables with named @@ -426,9 +397,11 @@ http://hdfgroup.org/HDF5/. For more information about parallel-netcdf, see their web site: http://www.mcs.anl.gov/parallel-netcdf. -\section netcdf_data_set_components The Components of a NetCDF Data Set +\page netcdf_data_set_components The Components of a NetCDF Data Set -\subsection data_model The Data Model +\tableofcontents + +\section data_model The Data Model A netCDF dataset contains dimensions, variables, and attributes, which all have both a name and an ID number by which they are @@ -438,7 +411,7 @@ dataset. The netCDF library allows simultaneous access to multiple netCDF datasets which are identified by dataset ID numbers, in addition to ordinary file names. -\subsubsection Enhanced Data Model in NetCDF-4/HDF5 Files +\subsection Enhanced Data Model in NetCDF-4/HDF5 Files Files created with the netCDF-4 format have access to an enhanced data model, which includes named groups. Groups, like directories in a Unix @@ -474,7 +447,7 @@ Groups and user-defined types are only available in files created in the netCDF-4/HDF5 format. They are not available for classic or 64-bit offset format files. -\subsection dimensions Dimensions +\section dimensions Dimensions A dimension may be used to represent a real physical dimension, for example, time, latitude, longitude, or height. A dimension might also @@ -536,7 +509,7 @@ data whose dimensions correspond to those of physical space/time should have a shape comprising different dimensions, even if some of these have the same length. -\subsection variables Variables +\section variables Variables Variables are used to store the bulk of the data in a netCDF dataset. A variable represents an array of values of the same type. A @@ -591,7 +564,7 @@ product is variable because it involves the length of the unlimited dimension, which can vary. The length of the unlimited dimension is the number of records. -\subsection coordinate_variables Coordinate Variables +\section coordinate_variables Coordinate Variables It is legal for a variable to have the same name as a dimension. Such variables have no special meaning to the netCDF library. However there @@ -633,7 +606,7 @@ use of coordinate variables commonly assume they are numeric vectors and strictly monotonic (all values are different and either increasing or decreasing). -\subsection attributes Attributes +\section attributes Attributes NetCDF attributes are used to store data about the data (ancillary data or metadata), similar in many ways to the information stored in @@ -721,7 +694,7 @@ attributes. However adding new attributes to an existing classic or 64-bit offset format dataset can incur the same expense as copying the dataset. For a more extensive discussion see Structure. -\subsection differences_atts_vars Differences between Attributes and Variables +\section differences_atts_vars Differences between Attributes and Variables In contrast to variables, which are intended for bulk data, attributes are intended for ancillary data, or information about the data. The @@ -750,9 +723,9 @@ defined netCDF dimensions to index their values, or require a significant amount of storage, that data should be represented using variables rather than attributes. -\subsection object_name NetCDF Names +\section object_name NetCDF Names -\subsubsection Permitted Characters in NetCDF Names +\subsection Permitted Characters in NetCDF Names The names of dimensions, variables and attributes (and, in netCDF-4 files, groups, user-defined types, compound member names, and @@ -770,7 +743,7 @@ Names that have trailing space characters are also not permitted. Case is significant in netCDF names. -\subsubsection Name Length +\subsection Name Length A zero-length name is not allowed. @@ -782,12 +755,12 @@ All netCDF inquiry functions will return names of maximum size terminating NULL, space should be reserved for NC_MAX_NAME + 1 characters. -\subsubsection NetCDF Conventions +\subsection NetCDF Conventions Some widely used conventions restrict names to only alphanumeric characters or underscores. -\subsection archival Is NetCDF a Good Archive Format? +\section archival Is NetCDF a Good Archive Format? NetCDF classic or 64-bit offset formats can be used as a general-purpose archive format for storing arrays. Compression of data @@ -805,7 +778,7 @@ others not. In this case the compression and decompression of data happen transparently to the user, and the data may be stored, read, and written compressed. -\subsection attribute_conventions Attribute Conventions +\section attribute_conventions Attribute Conventions Attribute conventions are assumed by some netCDF generic applications, e.g., ‘units’ as the name for a string attribute that gives the units @@ -821,7 +794,7 @@ character data. \note Attribute names commencing with underscore ('_') are reserved for use by the netCDF library. -\subsubsection units Units +\subsection units Units A character string that specifies the units used for the variable's data. Unidata has developed a freely-available library of routines to @@ -832,13 +805,13 @@ recommended units syntax permits data represented in conformable units to be automatically converted to common units for arithmetic operations. For more information see Units. -\subsubsection long_name Long Name +\subsection long_name Long Name A long descriptive name. This could be used for labeling plots, for example. If a variable has no long_name attribute assigned, the variable name should be used as a default. -\subsubsection _FillValue FillValue +\subsection _FillValue FillValue The _FillValue attribute specifies the fill value used to pre-fill disk space allocated to the variable. Such pre-fill occurs unless @@ -863,7 +836,7 @@ and therefore treated as missing when read by generic applications. It is legal (but not recommended) for the fill value to be within the valid range. -\subsubsection missing_value Missing Value +\subsection missing_value Missing Value This attribute is not treated in any special way by the library or conforming generic applications, but is often useful documentation and @@ -906,7 +879,7 @@ If the variable is packed using scale_factor and add_offset attributes (see below), the _FillValue, missing_value, valid_range, valid_min, or valid_max attributes should have the data type of the packed data. -\subsubsection scale_factor Scale Factor +\subsection scale_factor Scale Factor If present for a variable, the data are to be multiplied by this factor after the data are read by the application that accesses the @@ -918,7 +891,7 @@ specified in the domain of the data in the file (the packed data), so that they can be interpreted before the scale_factor and add_offset are applied. -\subsubsection add_offset Add Offset +\subsection add_offset Add Offset If present for a variable, this number is to be added to the data after it is read by the application that accesses the data. If both @@ -937,7 +910,7 @@ short, whereas the unpacked values are intended to be of type float or double. The attributes scale_factor and add_offset should both be of the type intended for the unpacked data, e.g. float or double. -\subsubsection coordinates Coordinates +\subsection coordinates Coordinates Following the CF (Climate and Forecast) conventions for netCDF metadata, we define an auxiliary coordinate variable as any netCDF @@ -951,7 +924,7 @@ names of auxiliary coordinate variables and (optionally) coordinate variables. There is no restriction on the order in which the variable names appear in the coordinates attribute string. -\subsubsection signedness Signedness +\subsection signedness Signedness Deprecated attribute, originally designed to indicate whether byte values should be treated as signed or unsigned. The attributes @@ -960,7 +933,7 @@ you intend that a byte variable store only non-negative values, you can use valid_min = 0 and valid_max = 255. This attribute is ignored by the netCDF library. -\subsubsection C_format C Format +\subsection C_format C Format \tableofcontents @@ -973,19 +946,19 @@ defined. The format applies to the scaled (internal) type and value, regardless of the presence of the scaling attributes scale_factor and add_offset. -\subsubsection FORTRAN_format FORTRAN format +\subsection FORTRAN_format FORTRAN format A character array providing the format that should be used by FORTRAN applications to print values for this variable. For example, if you know a variable is only accurate to three significant digits, it would be appropriate to define the FORTRAN_format attribute as "(G10.3)". -\subsubsection title Title +\subsection title Title A global attribute that is a character array providing a succinct description of what is in the dataset. -\subsubsection history History +\subsection history History A global attribute for an audit trail. This is a character array with a line for each invocation of a program that has modified the @@ -993,7 +966,7 @@ dataset. Well-behaved generic netCDF applications should append a line containing: date, time of day, user name, program name and command arguments. -\subsubsection Conventions Conventions +\subsection Conventions Conventions If present, 'Conventions' is a global attribute that is a character array for the name of the conventions followed by the @@ -1038,7 +1011,7 @@ Typical conventions web sites will include references to documents in some form agreed upon by the community that supports the conventions and examples of netCDF file structures that follow the conventions. -\subsection background Background and Evolution of the NetCDF Interface +\section background Background and Evolution of the NetCDF Interface The development of the netCDF interface began with a modest goal related to Unidata's needs: to provide a common interface between @@ -1263,12 +1236,12 @@ application is also included that provides a graphical user interface to capabilities similar to the C-based ncdump and ncgen utilities, as well as CF-compliance checking and many other features. -\subsection remote_client The Remote Data Access Client +\section remote_client The Remote Data Access Client Starting with version 4.1.1 the netCDF C libraries and utilities have supported remote data access. -\subsection data_access Data Access +\section data_access Data Access To access (read or write) netCDF data you specify an open netCDF dataset, a netCDF variable, and information (e.g., indices) @@ -1297,7 +1270,7 @@ Similarly, a variable is not specified by name for every data access either, but by a variable ID, a small integer used to identify each variable in a netCDF dataset. -\subsection forms_of_data_access Forms of Data Access +\section forms_of_data_access Forms of Data Access The netCDF interface supports several forms of direct access to data values in an open netCDF dataset. We describe each of these forms of @@ -1344,7 +1317,7 @@ The use of mapped array sections is discussed more fully below, but first we present an example of the more commonly used array-section access. -\subsection c_array_section_access A C Example of Array-Section Access +\section c_array_section_access A C Example of Array-Section Access Assume that in our earlier example of a netCDF dataset (see Network Common Data Form Language (CDL)), we wish to read a cross-section of @@ -1476,11 +1449,13 @@ required. If you do not need these more general forms of access, you may ignore these capabilities and use single value access or regular array section access instead. -\section file_structure_and_performance File Structure and Performance +\page file_structure_and_performance File Structure and Performance + +\tableofcontents \todo Indent the following part below this. -\section classic_file_parts Parts of a NetCDF Classic File +\section classic_file_parts Parts of a NetCDF Classic File A netCDF classic or 64-bit offset dataset is stored as a single file comprising two parts: @@ -2081,7 +2056,7 @@ within grids are left out in order to mimic the behavior of libnc-dap. lon \endcode -\subsubsection var_dim_trans Variable Dimension Translation +\subsection var_dim_trans Variable Dimension Translation A variable's rank is determined from three sources. - The variable has the dimensions associated with the field it @@ -2175,7 +2150,7 @@ dimensions: S1.FS2.f2_0 = 2 ; \endcode -\subsubsection var_name_trans Variable Name Translation +\subsection var_name_trans Variable Name Translation The steps for variable name translation are as follows. @@ -2523,6 +2498,10 @@ entries should have same value, which is the file path for the certificate produced by MyProxyLogon. The HTTP.SSL.CAPATH entry should be the path to the "certificates" directory produced by MyProxyLogon. +\page netcdf_perf_chunking Improving Performance with Chunking + +\tableofcontents + \section chunk_cache The Chunk Cache When data are first read or written to a netCDF-4/HDF5 variable, the @@ -2674,9 +2653,11 @@ The bm_file program is controlled with command line options. file Name of netCDF file -\section netcdf_utilities_guide Netcdf Utilities +\page netcdf_utilities_guide Netcdf Utilities -\subsection cdl_syntax CDL Syntax +\tableofcontents + +\section cdl_syntax CDL Syntax Below is an example of CDL, describing a netCDF classic format file with several named dimensions (lat, lon, time), variables (z, t, p, rh, lat, lon, @@ -2816,7 +2797,7 @@ conversions among numeric primitive types are supported. A special notation for fill values is supported: the ‘_’ character designates a fill value for variables. -\subsection cdl_data_types CDL Data Types +\section cdl_data_types CDL Data Types The CDL primitive data types for the classic model are: - char - Characters. @@ -2880,7 +2861,7 @@ encouraged to add the special variable attribute "_Encoding" with a value that the netCDF libraries recognize. Currently those valid values are "UTF-8" or "ASCII", case insensitive. -\subsection cdl_constants CDL Notation for Data Constants +\section cdl_constants CDL Notation for Data Constants This section describes the CDL notation for constants. @@ -3000,11 +2981,11 @@ extended as necessary. The ncgen man-page reference has more details about CDL representation of constants of user-defined types. -\subsection guide_ncdump ncdump +\section guide_ncdump ncdump \brief Convert netCDF file to text form (CDL) -\subsubsection ncdump_SYNOPSIS ncdump synopsis +\subsection ncdump_SYNOPSIS ncdump synopsis \code ncdump [-chistxw] [-v var1,...] [-b lang] [-f lang] @@ -3014,7 +2995,7 @@ ncdump [-chistxw] [-v var1,...] [-b lang] [-f lang] ncdump -k file \endcode -\subsubsection ncdump_DESCRIPTION ncdump description +\subsection ncdump_DESCRIPTION ncdump description The \b ncdump utility generates a text representation of a specified netCDF file on standard output, optionally excluding some or all of @@ -3061,7 +3042,7 @@ be appropriate to use the variable attribute Z:C_format = "%.3g" \endcode -\subsubsection ncdump_OPTIONS ncdump options +\subsection ncdump_OPTIONS ncdump options @par -c Show the values of \e coordinate \e variables (1D variables with the @@ -3212,7 +3193,7 @@ with client-side caching of entire variables. Output XML (NcML) instead of CDL. The NcML does not include data values. The NcML output option currently only works for netCDF classic model data. -\subsubsection ncdump_EXAMPLES ncdump examples +\subsection ncdump_EXAMPLES ncdump examples Look at the structure of the data in the netCDF file foo.nc: @@ -3257,26 +3238,26 @@ performance-related characterisitics of a netCDF-4 file: ncdump -h -s nc4file.nc \endcode -\subsubsection see_also_ncdump SEE ALSO +\subsection see_also_ncdump SEE ALSO ncgen(1), netcdf(3) - \ref guide_ncgen - \ref guide_nccopy -\subsubsection ncdump_string_note NOTE ON STRING OUTPUT +\subsection ncdump_string_note NOTE ON STRING OUTPUT For classic, 64-bit offset or netCDF-4 classic model data, \b ncdump generates line breaks after embedded newlines in displaying character data. This is not done for netCDF-4 files, because netCDF-4 supports arrays of real strings of varying length. -\subsection guide_nccopy nccopy +\section guide_nccopy nccopy \brief Copy a netCDF file, optionally changing format, compression, or chunking in the output. -\subsubsection nccopy_SYNOPSIS nccopy synopsis +\subsection nccopy_SYNOPSIS nccopy synopsis \code nccopy [-k kind] [-d n] [-s] [-c chunkspec] [-u] [-w] [-[v|V] var1,...] @@ -3284,7 +3265,7 @@ nccopy [-k kind] [-d n] [-s] [-c chunkspec] [-u] [-w] [-[v|V] var1,...] [-r] infile outfile \endcode -\subsubsection nccopy_DESCRIPTION nccopy description +\subsection nccopy_DESCRIPTION nccopy description The \b nccopy utility copies an input netCDF file in any supported format variant to an output netCDF file, optionally converting the @@ -3307,7 +3288,7 @@ If DAP support was enabled when \b nccopy was built, the file name may specify a DAP URL. This may be used to convert data on DAP servers to local netCDF files. -\subsubsection nccopy_OPTIONS nccopy options +\subsection nccopy_OPTIONS nccopy options \par -k \e kind Specifies the kind of file to be created (that is, the format variant) @@ -3503,7 +3484,7 @@ file in memory before copying. Requires that input file be small enough to fit into memory. For \b nccopy, this doesn't seem to provide any significant speedup, so may not be a useful option. -\subsubsection nccopy_EXAMPLES nccopy examples +\subsection nccopy_EXAMPLES nccopy examples

Simple Copy

Make a copy of foo1.nc, a netCDF file of any type, to @@ -3577,11 +3558,11 @@ memory before writing it to disk on close: nccopy -w -c time/1000,lat/40,lon/40 slow.nc fast.nc \endcode -\subsubsection see_also_nccopy SEE ALSO +\subsection see_also_nccopy SEE ALSO ncdump(1), ncgen(1), netcdf(3) -\subsection guide_ncgen ncgen +\section guide_ncgen ncgen The ncgen tool generates a netCDF file or a C or FORTRAN program that creates a netCDF dataset. If no options are specified in invoking @@ -3683,7 +3664,7 @@ dataset: ncgen -l c foo.cdl > foo.c \endcode -\subsection guide_ncgen3 ncgen3 +\section guide_ncgen3 ncgen3 The ncgen3 tool is the new name for the older, original ncgen utility. @@ -3748,8 +3729,11 @@ faster, but it will also eliminate the possibility of detecting the inadvertent reading of values that haven't been written. +\page file_format_specifications File Format Specifications -\section file_format_spec_guide NetCDF File Format Specification +\tableofcontents + +\todo Wrap the following group of pages into this. From NetCDF Classic Format Spec through HDF4 SD Format. \section classic_format_spec The NetCDF Classic Format Specification @@ -4058,7 +4042,7 @@ A special case: Where there is exactly one record variable, we drop the requirement that each record be four-byte aligned, so in this case there is no record padding. -\section offset_examples Examples +\subsection offset_examples Examples By using the grammar above, we can derive the smallest valid netCDF file, having no dimensions, no variables, no attributes, and hence, no From dc1b737a020bbf0af7b3ea97ec2e3c34ed371f34 Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Tue, 4 Mar 2014 15:01:49 -0700 Subject: [PATCH 2/8] Modified visability of the external groups and pages. --- man4/Doxyfile.guide.in | 4 ++-- man4/Doxyfile.in | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/man4/Doxyfile.guide.in b/man4/Doxyfile.guide.in index b173f18ea..993800c27 100644 --- a/man4/Doxyfile.guide.in +++ b/man4/Doxyfile.guide.in @@ -2022,14 +2022,14 @@ ALLEXTERNALS = NO # listed. # The default value is: YES. -EXTERNAL_GROUPS = YES +EXTERNAL_GROUPS = NO # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. -EXTERNAL_PAGES = YES +EXTERNAL_PAGES = NO # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of 'which perl'). diff --git a/man4/Doxyfile.in b/man4/Doxyfile.in index 0f556d7eb..702d51c83 100644 --- a/man4/Doxyfile.in +++ b/man4/Doxyfile.in @@ -2069,14 +2069,14 @@ ALLEXTERNALS = NO # listed. # The default value is: YES. -EXTERNAL_GROUPS = YES +EXTERNAL_GROUPS = NO # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. -EXTERNAL_PAGES = YES +EXTERNAL_PAGES = NO # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of 'which perl'). From 19129aa956c44ec8ab5f4726e9c085cf9e8b0c05 Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Tue, 4 Mar 2014 15:19:48 -0700 Subject: [PATCH 3/8] Adding proper section names to 'Example' sections, to avoid Doxygen warnings. --- libdispatch/dattinq.c | 2 +- libdispatch/dattput.c | 2 +- man4/guide.dox | 7 ++++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/libdispatch/dattinq.c b/libdispatch/dattinq.c index c9d2c0755..4bc99d78a 100644 --- a/libdispatch/dattinq.c +++ b/libdispatch/dattinq.c @@ -39,7 +39,7 @@ doesn't if the attribute was stored without a trailing zero byte, for example from a FORTRAN program. Before using the value as a C string, make sure it is null-terminated. \ref ignored_if_null. -\section Example +\section nc_inq_att_example Example Here is an example using nc_inq_att() to find out the type and length of a variable attribute named valid_range for a netCDF variable named rh diff --git a/libdispatch/dattput.c b/libdispatch/dattput.c index 5928ed0c6..cf2600088 100644 --- a/libdispatch/dattput.c +++ b/libdispatch/dattput.c @@ -96,7 +96,7 @@ is still in initial define mode. _Fill_Value_ attribute, and will tell the HDF5 layer to use the specified fill value for that variable. -\section Example +\section nc_put_att_text_example Example Here is an example using nc_put_att_double() to add a variable attribute named valid_range for a netCDF variable named rh and diff --git a/man4/guide.dox b/man4/guide.dox index 80be8c870..c02cb45df 100644 --- a/man4/guide.dox +++ b/man4/guide.dox @@ -4,8 +4,11 @@ \mainpage +\tableofcontents + \section user_guide The NetCDF User's Guide +- \ref mainpage_netcdf - \subpage netcdf_summary - \subpage netcdf_introduction - \subpage file_structure_and_performance @@ -23,9 +26,7 @@ Data - \ref remote_client - \ref type_conversion -\page netcdf_summary NetCDF Summary - -\tableofcontents +\section netcdf_summary The Purpose of NetCDF The purpose of the Network Common Data Form (netCDF) interface is to allow you to create, access, and share array-oriented data in a form From 3c846763acad98939c972083fe0a03f0893c5f68 Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Tue, 4 Mar 2014 14:27:58 -0700 Subject: [PATCH 4/8] Initial split of Guide from rest of documentation. Using 'tagfiles' to cross-reference from one documentation set to the other works, but then it drags all of the 'external' related pages into the index of the other. --- man4/Doxyfile.guide.in | 6 +- man4/Doxyfile.in | 5 +- man4/guide.dox | 204 +++++++++++++++++++---------------------- 3 files changed, 99 insertions(+), 116 deletions(-) diff --git a/man4/Doxyfile.guide.in b/man4/Doxyfile.guide.in index d9ec72c61..b173f18ea 100644 --- a/man4/Doxyfile.guide.in +++ b/man4/Doxyfile.guide.in @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = NetCDF +PROJECT_NAME = "The NetCDF User's Guide" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -2003,13 +2003,13 @@ SKIP_FUNCTION_MACROS = YES # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = @CMAKE_CURRENT_BINARY_DIR@/main.tag=../ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = +GENERATE_TAGFILE = @CMAKE_CURRENT_BINARY_DIR@/guide.tag # If the ALLEXTERNALS tag is set to YES all external class will be listed in the # class index. If set to NO only the inherited external classes will be listed. diff --git a/man4/Doxyfile.in b/man4/Doxyfile.in index ce8ee6e01..2834fea45 100644 --- a/man4/Doxyfile.in +++ b/man4/Doxyfile.in @@ -750,7 +750,6 @@ INPUT = \ @abs_top_srcdir@/man4/install.md \ @abs_top_srcdir@/man4/install-fortran.md \ @abs_top_srcdir@/man4/dispatch.dox \ - @abs_top_srcdir@/man4/guide.dox \ @abs_top_srcdir@/man4/types.dox \ @abs_top_srcdir@/man4/notes.dox \ @abs_top_srcdir@/man4/cdl.dox \ @@ -2052,13 +2051,13 @@ SKIP_FUNCTION_MACROS = YES # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = @CMAKE_CURRENT_BINARY_DIR@/guide.tag=html_guide/ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = +GENERATE_TAGFILE = @CMAKE_CURRENT_BINARY_DIR@/main.tag # If the ALLEXTERNALS tag is set to YES all external class will be listed in the # class index. If set to NO only the inherited external classes will be listed. diff --git a/man4/guide.dox b/man4/guide.dox index 6723dfc10..80be8c870 100644 --- a/man4/guide.dox +++ b/man4/guide.dox @@ -1,12 +1,18 @@ -/*! \file +/*! \file guide.dox The NetCDF User's Guide -NetCDF Users Guide +\brief The NetCDF User's Guide -The NetCDF Users Guide +\mainpage -\page user_guide The NetCDF Users Guide +\section user_guide The NetCDF User's Guide -\tableofcontents +- \subpage netcdf_summary +- \subpage netcdf_introduction +- \subpage file_structure_and_performance +- \subpage netcdf_data_set_components +- \subpage netcdf_perf_chunking +- \subpage netcdf_utilities_guide +- \subpage file_format_specifications Data - \ref external_types @@ -17,46 +23,9 @@ Data - \ref remote_client - \ref type_conversion -File Structure and Performance -- \ref classic_file_parts -- \ref parts_of_netcdf4 -- \ref xdr_layer -- \ref large_file_support -- \ref offset_format_limitations -- \ref classic_format_limitations -- \ref netcdf_3_io -- \ref parallel_access -- \ref interoperability_with_hdf5 -- \ref creating_self -- \ref dap_support +\page netcdf_summary NetCDF Summary -Improving Performance with Chunking -- \ref chunk_cache -- \ref default_chunking_4_1 -- default_chunking_4_0_1 -- \ref chunking_parallel_io -- \ref bm_file - -NetCDF Utilities -- \ref cdl_syntax -- \ref cdl_data_types -- \ref cdl_constants -- \ref guide_ncgen -- \ref guide_ncdump -- \ref guide_nccopy -- \ref guide_ncgen3 - -File Format Specification -- \ref classic_format_spec -- \ref computing_offsets -- \ref offset_examples -- \ref offset_format_spec -- \ref netcdf_4_spec -- \ref netcdf_4_classic_spec -- \ref hdf4_sd_format - - -\section netcdf_summary Summary +\tableofcontents The purpose of the Network Common Data Form (netCDF) interface is to allow you to create, access, and share array-oriented data in a form @@ -97,9 +66,11 @@ software that works with netCDF data. Separate documentation of the Java netCDF library can be found at http://www.unidata.ucar.edu/software/netcdf-java. -\section netcdf_introduction An Introduction to NetCDF +\page netcdf_introduction An Introduction to NetCDF -\subsection netcdf_interface The NetCDF Interface +\tableofcontents + +\section netcdf_interface The NetCDF Interface The Network Common Data Form, or netCDF, is an interface to a library of data access functions for storing and retrieving data in the form @@ -149,7 +120,7 @@ its widespread use. For detailed installation instructions, see Building NetCDF. -\subsection netcdf_format The netCDF File Format +\section netcdf_format The netCDF File Format Until version 3.6.0, all versions of netCDF employed only one binary data format, now referred to as netCDF classic format. NetCDF classic @@ -189,7 +160,7 @@ using the format specification to develop independent low-level software for reading and writing netCDF files, because this could lead to compatibility problems if the format is ever modified. -\subsubsection select_format How to Select the Format +\subsection select_format How to Select the Format With three different base formats, care must be taken in creating data files to choose the correct base format. @@ -217,7 +188,7 @@ It is also possible to change the default creation format, to convert a large body of code without changing every create call. C programmers see nc_set_default_format. Fortran programs see NF_SET_DEFAULT_FORMAT. -\subsubsection classic_format NetCDF Classic Format +\subsection classic_format NetCDF Classic Format The original netCDF format is identified using four bytes in the file header. All files in this format have “CDF\001” at the beginning of @@ -243,7 +214,7 @@ beginning of the file. In this documentation this format is called Since 64-bit offset format was introduced in version 3.6.0, earlier versions of the netCDF library can't read 64-bit offset files. -\subsubsection netcdf_4_format NetCDF-4 Format +\subsection netcdf_4_format NetCDF-4 Format In version 4.0, netCDF included another new underlying format: HDF5. @@ -266,7 +237,7 @@ better). For more discussion of format issues see The NetCDF Tutorial. -\subsection performance What about Performance? +\section performance What about Performance? One of the goals of netCDF is to support efficient access to small subsets of large datasets. To support this goal, netCDF uses direct @@ -295,7 +266,7 @@ operations, less so in data access operations. We continue to study the challenge of implementing netCDF-4/HDF5 format without compromising performance. -\subsection creating_self Creating Self-Describing Data conforming to Conventions +\section creating_self Creating Self-Describing Data conforming to Conventions The mere use of netCDF is not sufficient to make data "self-describing" and meaningful to both humans and machines. The @@ -319,7 +290,7 @@ conventions are often needed for local use. These should be contributed to the above netCDF conventions site if likely to interest other users in similar areas. -\subsection limitations Limitations of NetCDF +\section limitations Limitations of NetCDF The netCDF classic data model is widely applicable to data that can be organized into a collection of named array variables with named @@ -426,9 +397,11 @@ http://hdfgroup.org/HDF5/. For more information about parallel-netcdf, see their web site: http://www.mcs.anl.gov/parallel-netcdf. -\section netcdf_data_set_components The Components of a NetCDF Data Set +\page netcdf_data_set_components The Components of a NetCDF Data Set -\subsection data_model The Data Model +\tableofcontents + +\section data_model The Data Model A netCDF dataset contains dimensions, variables, and attributes, which all have both a name and an ID number by which they are @@ -438,7 +411,7 @@ dataset. The netCDF library allows simultaneous access to multiple netCDF datasets which are identified by dataset ID numbers, in addition to ordinary file names. -\subsubsection Enhanced Data Model in NetCDF-4/HDF5 Files +\subsection Enhanced Data Model in NetCDF-4/HDF5 Files Files created with the netCDF-4 format have access to an enhanced data model, which includes named groups. Groups, like directories in a Unix @@ -474,7 +447,7 @@ Groups and user-defined types are only available in files created in the netCDF-4/HDF5 format. They are not available for classic or 64-bit offset format files. -\subsection dimensions Dimensions +\section dimensions Dimensions A dimension may be used to represent a real physical dimension, for example, time, latitude, longitude, or height. A dimension might also @@ -536,7 +509,7 @@ data whose dimensions correspond to those of physical space/time should have a shape comprising different dimensions, even if some of these have the same length. -\subsection variables Variables +\section variables Variables Variables are used to store the bulk of the data in a netCDF dataset. A variable represents an array of values of the same type. A @@ -591,7 +564,7 @@ product is variable because it involves the length of the unlimited dimension, which can vary. The length of the unlimited dimension is the number of records. -\subsection coordinate_variables Coordinate Variables +\section coordinate_variables Coordinate Variables It is legal for a variable to have the same name as a dimension. Such variables have no special meaning to the netCDF library. However there @@ -633,7 +606,7 @@ use of coordinate variables commonly assume they are numeric vectors and strictly monotonic (all values are different and either increasing or decreasing). -\subsection attributes Attributes +\section attributes Attributes NetCDF attributes are used to store data about the data (ancillary data or metadata), similar in many ways to the information stored in @@ -721,7 +694,7 @@ attributes. However adding new attributes to an existing classic or 64-bit offset format dataset can incur the same expense as copying the dataset. For a more extensive discussion see Structure. -\subsection differences_atts_vars Differences between Attributes and Variables +\section differences_atts_vars Differences between Attributes and Variables In contrast to variables, which are intended for bulk data, attributes are intended for ancillary data, or information about the data. The @@ -750,9 +723,9 @@ defined netCDF dimensions to index their values, or require a significant amount of storage, that data should be represented using variables rather than attributes. -\subsection object_name NetCDF Names +\section object_name NetCDF Names -\subsubsection Permitted Characters in NetCDF Names +\subsection Permitted Characters in NetCDF Names The names of dimensions, variables and attributes (and, in netCDF-4 files, groups, user-defined types, compound member names, and @@ -770,7 +743,7 @@ Names that have trailing space characters are also not permitted. Case is significant in netCDF names. -\subsubsection Name Length +\subsection Name Length A zero-length name is not allowed. @@ -782,12 +755,12 @@ All netCDF inquiry functions will return names of maximum size terminating NULL, space should be reserved for NC_MAX_NAME + 1 characters. -\subsubsection NetCDF Conventions +\subsection NetCDF Conventions Some widely used conventions restrict names to only alphanumeric characters or underscores. -\subsection archival Is NetCDF a Good Archive Format? +\section archival Is NetCDF a Good Archive Format? NetCDF classic or 64-bit offset formats can be used as a general-purpose archive format for storing arrays. Compression of data @@ -805,7 +778,7 @@ others not. In this case the compression and decompression of data happen transparently to the user, and the data may be stored, read, and written compressed. -\subsection attribute_conventions Attribute Conventions +\section attribute_conventions Attribute Conventions Attribute conventions are assumed by some netCDF generic applications, e.g., ‘units’ as the name for a string attribute that gives the units @@ -821,7 +794,7 @@ character data. \note Attribute names commencing with underscore ('_') are reserved for use by the netCDF library. -\subsubsection units Units +\subsection units Units A character string that specifies the units used for the variable's data. Unidata has developed a freely-available library of routines to @@ -832,13 +805,13 @@ recommended units syntax permits data represented in conformable units to be automatically converted to common units for arithmetic operations. For more information see Units. -\subsubsection long_name Long Name +\subsection long_name Long Name A long descriptive name. This could be used for labeling plots, for example. If a variable has no long_name attribute assigned, the variable name should be used as a default. -\subsubsection _FillValue FillValue +\subsection _FillValue FillValue The _FillValue attribute specifies the fill value used to pre-fill disk space allocated to the variable. Such pre-fill occurs unless @@ -863,7 +836,7 @@ and therefore treated as missing when read by generic applications. It is legal (but not recommended) for the fill value to be within the valid range. -\subsubsection missing_value Missing Value +\subsection missing_value Missing Value This attribute is not treated in any special way by the library or conforming generic applications, but is often useful documentation and @@ -906,7 +879,7 @@ If the variable is packed using scale_factor and add_offset attributes (see below), the _FillValue, missing_value, valid_range, valid_min, or valid_max attributes should have the data type of the packed data. -\subsubsection scale_factor Scale Factor +\subsection scale_factor Scale Factor If present for a variable, the data are to be multiplied by this factor after the data are read by the application that accesses the @@ -918,7 +891,7 @@ specified in the domain of the data in the file (the packed data), so that they can be interpreted before the scale_factor and add_offset are applied. -\subsubsection add_offset Add Offset +\subsection add_offset Add Offset If present for a variable, this number is to be added to the data after it is read by the application that accesses the data. If both @@ -937,7 +910,7 @@ short, whereas the unpacked values are intended to be of type float or double. The attributes scale_factor and add_offset should both be of the type intended for the unpacked data, e.g. float or double. -\subsubsection coordinates Coordinates +\subsection coordinates Coordinates Following the CF (Climate and Forecast) conventions for netCDF metadata, we define an auxiliary coordinate variable as any netCDF @@ -951,7 +924,7 @@ names of auxiliary coordinate variables and (optionally) coordinate variables. There is no restriction on the order in which the variable names appear in the coordinates attribute string. -\subsubsection signedness Signedness +\subsection signedness Signedness Deprecated attribute, originally designed to indicate whether byte values should be treated as signed or unsigned. The attributes @@ -960,7 +933,7 @@ you intend that a byte variable store only non-negative values, you can use valid_min = 0 and valid_max = 255. This attribute is ignored by the netCDF library. -\subsubsection C_format C Format +\subsection C_format C Format \tableofcontents @@ -973,19 +946,19 @@ defined. The format applies to the scaled (internal) type and value, regardless of the presence of the scaling attributes scale_factor and add_offset. -\subsubsection FORTRAN_format FORTRAN format +\subsection FORTRAN_format FORTRAN format A character array providing the format that should be used by FORTRAN applications to print values for this variable. For example, if you know a variable is only accurate to three significant digits, it would be appropriate to define the FORTRAN_format attribute as "(G10.3)". -\subsubsection title Title +\subsection title Title A global attribute that is a character array providing a succinct description of what is in the dataset. -\subsubsection history History +\subsection history History A global attribute for an audit trail. This is a character array with a line for each invocation of a program that has modified the @@ -993,7 +966,7 @@ dataset. Well-behaved generic netCDF applications should append a line containing: date, time of day, user name, program name and command arguments. -\subsubsection Conventions Conventions +\subsection Conventions Conventions If present, 'Conventions' is a global attribute that is a character array for the name of the conventions followed by the @@ -1038,7 +1011,7 @@ Typical conventions web sites will include references to documents in some form agreed upon by the community that supports the conventions and examples of netCDF file structures that follow the conventions. -\subsection background Background and Evolution of the NetCDF Interface +\section background Background and Evolution of the NetCDF Interface The development of the netCDF interface began with a modest goal related to Unidata's needs: to provide a common interface between @@ -1263,12 +1236,12 @@ application is also included that provides a graphical user interface to capabilities similar to the C-based ncdump and ncgen utilities, as well as CF-compliance checking and many other features. -\subsection remote_client The Remote Data Access Client +\section remote_client The Remote Data Access Client Starting with version 4.1.1 the netCDF C libraries and utilities have supported remote data access. -\subsection data_access Data Access +\section data_access Data Access To access (read or write) netCDF data you specify an open netCDF dataset, a netCDF variable, and information (e.g., indices) @@ -1297,7 +1270,7 @@ Similarly, a variable is not specified by name for every data access either, but by a variable ID, a small integer used to identify each variable in a netCDF dataset. -\subsection forms_of_data_access Forms of Data Access +\section forms_of_data_access Forms of Data Access The netCDF interface supports several forms of direct access to data values in an open netCDF dataset. We describe each of these forms of @@ -1344,7 +1317,7 @@ The use of mapped array sections is discussed more fully below, but first we present an example of the more commonly used array-section access. -\subsection c_array_section_access A C Example of Array-Section Access +\section c_array_section_access A C Example of Array-Section Access Assume that in our earlier example of a netCDF dataset (see Network Common Data Form Language (CDL)), we wish to read a cross-section of @@ -1476,11 +1449,13 @@ required. If you do not need these more general forms of access, you may ignore these capabilities and use single value access or regular array section access instead. -\section file_structure_and_performance File Structure and Performance +\page file_structure_and_performance File Structure and Performance + +\tableofcontents \todo Indent the following part below this. -\section classic_file_parts Parts of a NetCDF Classic File +\section classic_file_parts Parts of a NetCDF Classic File A netCDF classic or 64-bit offset dataset is stored as a single file comprising two parts: @@ -2081,7 +2056,7 @@ within grids are left out in order to mimic the behavior of libnc-dap. lon \endcode -\subsubsection var_dim_trans Variable Dimension Translation +\subsection var_dim_trans Variable Dimension Translation A variable's rank is determined from three sources. - The variable has the dimensions associated with the field it @@ -2175,7 +2150,7 @@ dimensions: S1.FS2.f2_0 = 2 ; \endcode -\subsubsection var_name_trans Variable Name Translation +\subsection var_name_trans Variable Name Translation The steps for variable name translation are as follows. @@ -2523,6 +2498,10 @@ entries should have same value, which is the file path for the certificate produced by MyProxyLogon. The HTTP.SSL.CAPATH entry should be the path to the "certificates" directory produced by MyProxyLogon. +\page netcdf_perf_chunking Improving Performance with Chunking + +\tableofcontents + \section chunk_cache The Chunk Cache When data are first read or written to a netCDF-4/HDF5 variable, the @@ -2674,9 +2653,11 @@ The bm_file program is controlled with command line options. file Name of netCDF file -\section netcdf_utilities_guide Netcdf Utilities +\page netcdf_utilities_guide Netcdf Utilities -\subsection cdl_syntax CDL Syntax +\tableofcontents + +\section cdl_syntax CDL Syntax Below is an example of CDL, describing a netCDF classic format file with several named dimensions (lat, lon, time), variables (z, t, p, rh, lat, lon, @@ -2816,7 +2797,7 @@ conversions among numeric primitive types are supported. A special notation for fill values is supported: the ‘_’ character designates a fill value for variables. -\subsection cdl_data_types CDL Data Types +\section cdl_data_types CDL Data Types The CDL primitive data types for the classic model are: - char - Characters. @@ -2880,7 +2861,7 @@ encouraged to add the special variable attribute "_Encoding" with a value that the netCDF libraries recognize. Currently those valid values are "UTF-8" or "ASCII", case insensitive. -\subsection cdl_constants CDL Notation for Data Constants +\section cdl_constants CDL Notation for Data Constants This section describes the CDL notation for constants. @@ -3000,11 +2981,11 @@ extended as necessary. The ncgen man-page reference has more details about CDL representation of constants of user-defined types. -\subsection guide_ncdump ncdump +\section guide_ncdump ncdump \brief Convert netCDF file to text form (CDL) -\subsubsection ncdump_SYNOPSIS ncdump synopsis +\subsection ncdump_SYNOPSIS ncdump synopsis \code ncdump [-chistxw] [-v var1,...] [-b lang] [-f lang] @@ -3014,7 +2995,7 @@ ncdump [-chistxw] [-v var1,...] [-b lang] [-f lang] ncdump -k file \endcode -\subsubsection ncdump_DESCRIPTION ncdump description +\subsection ncdump_DESCRIPTION ncdump description The \b ncdump utility generates a text representation of a specified netCDF file on standard output, optionally excluding some or all of @@ -3061,7 +3042,7 @@ be appropriate to use the variable attribute Z:C_format = "%.3g" \endcode -\subsubsection ncdump_OPTIONS ncdump options +\subsection ncdump_OPTIONS ncdump options @par -c Show the values of \e coordinate \e variables (1D variables with the @@ -3212,7 +3193,7 @@ with client-side caching of entire variables. Output XML (NcML) instead of CDL. The NcML does not include data values. The NcML output option currently only works for netCDF classic model data. -\subsubsection ncdump_EXAMPLES ncdump examples +\subsection ncdump_EXAMPLES ncdump examples Look at the structure of the data in the netCDF file foo.nc: @@ -3257,26 +3238,26 @@ performance-related characterisitics of a netCDF-4 file: ncdump -h -s nc4file.nc \endcode -\subsubsection see_also_ncdump SEE ALSO +\subsection see_also_ncdump SEE ALSO ncgen(1), netcdf(3) - \ref guide_ncgen - \ref guide_nccopy -\subsubsection ncdump_string_note NOTE ON STRING OUTPUT +\subsection ncdump_string_note NOTE ON STRING OUTPUT For classic, 64-bit offset or netCDF-4 classic model data, \b ncdump generates line breaks after embedded newlines in displaying character data. This is not done for netCDF-4 files, because netCDF-4 supports arrays of real strings of varying length. -\subsection guide_nccopy nccopy +\section guide_nccopy nccopy \brief Copy a netCDF file, optionally changing format, compression, or chunking in the output. -\subsubsection nccopy_SYNOPSIS nccopy synopsis +\subsection nccopy_SYNOPSIS nccopy synopsis \code nccopy [-k kind] [-d n] [-s] [-c chunkspec] [-u] [-w] [-[v|V] var1,...] @@ -3284,7 +3265,7 @@ nccopy [-k kind] [-d n] [-s] [-c chunkspec] [-u] [-w] [-[v|V] var1,...] [-r] infile outfile \endcode -\subsubsection nccopy_DESCRIPTION nccopy description +\subsection nccopy_DESCRIPTION nccopy description The \b nccopy utility copies an input netCDF file in any supported format variant to an output netCDF file, optionally converting the @@ -3307,7 +3288,7 @@ If DAP support was enabled when \b nccopy was built, the file name may specify a DAP URL. This may be used to convert data on DAP servers to local netCDF files. -\subsubsection nccopy_OPTIONS nccopy options +\subsection nccopy_OPTIONS nccopy options \par -k \e kind Specifies the kind of file to be created (that is, the format variant) @@ -3503,7 +3484,7 @@ file in memory before copying. Requires that input file be small enough to fit into memory. For \b nccopy, this doesn't seem to provide any significant speedup, so may not be a useful option. -\subsubsection nccopy_EXAMPLES nccopy examples +\subsection nccopy_EXAMPLES nccopy examples

Simple Copy

Make a copy of foo1.nc, a netCDF file of any type, to @@ -3577,11 +3558,11 @@ memory before writing it to disk on close: nccopy -w -c time/1000,lat/40,lon/40 slow.nc fast.nc \endcode -\subsubsection see_also_nccopy SEE ALSO +\subsection see_also_nccopy SEE ALSO ncdump(1), ncgen(1), netcdf(3) -\subsection guide_ncgen ncgen +\section guide_ncgen ncgen The ncgen tool generates a netCDF file or a C or FORTRAN program that creates a netCDF dataset. If no options are specified in invoking @@ -3683,7 +3664,7 @@ dataset: ncgen -l c foo.cdl > foo.c \endcode -\subsection guide_ncgen3 ncgen3 +\section guide_ncgen3 ncgen3 The ncgen3 tool is the new name for the older, original ncgen utility. @@ -3748,8 +3729,11 @@ faster, but it will also eliminate the possibility of detecting the inadvertent reading of values that haven't been written. +\page file_format_specifications File Format Specifications -\section file_format_spec_guide NetCDF File Format Specification +\tableofcontents + +\todo Wrap the following group of pages into this. From NetCDF Classic Format Spec through HDF4 SD Format. \section classic_format_spec The NetCDF Classic Format Specification @@ -4058,7 +4042,7 @@ A special case: Where there is exactly one record variable, we drop the requirement that each record be four-byte aligned, so in this case there is no record padding. -\section offset_examples Examples +\subsection offset_examples Examples By using the grammar above, we can derive the smallest valid netCDF file, having no dimensions, no variables, no attributes, and hence, no From e3fb11af40384b93ebcbf1a671292b0fbf627287 Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Tue, 4 Mar 2014 15:01:49 -0700 Subject: [PATCH 5/8] Modified visability of the external groups and pages. --- man4/Doxyfile.guide.in | 4 ++-- man4/Doxyfile.in | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/man4/Doxyfile.guide.in b/man4/Doxyfile.guide.in index b173f18ea..993800c27 100644 --- a/man4/Doxyfile.guide.in +++ b/man4/Doxyfile.guide.in @@ -2022,14 +2022,14 @@ ALLEXTERNALS = NO # listed. # The default value is: YES. -EXTERNAL_GROUPS = YES +EXTERNAL_GROUPS = NO # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. -EXTERNAL_PAGES = YES +EXTERNAL_PAGES = NO # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of 'which perl'). diff --git a/man4/Doxyfile.in b/man4/Doxyfile.in index 2834fea45..4e407491e 100644 --- a/man4/Doxyfile.in +++ b/man4/Doxyfile.in @@ -2070,14 +2070,14 @@ ALLEXTERNALS = NO # listed. # The default value is: YES. -EXTERNAL_GROUPS = YES +EXTERNAL_GROUPS = NO # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. -EXTERNAL_PAGES = YES +EXTERNAL_PAGES = NO # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of 'which perl'). From 3c0e39c0284a297946c75997ffefe7b309ab2eba Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Tue, 4 Mar 2014 15:19:48 -0700 Subject: [PATCH 6/8] Adding proper section names to 'Example' sections, to avoid Doxygen warnings. --- libdispatch/dattinq.c | 2 +- libdispatch/dattput.c | 2 +- man4/guide.dox | 7 ++++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/libdispatch/dattinq.c b/libdispatch/dattinq.c index c9d2c0755..4bc99d78a 100644 --- a/libdispatch/dattinq.c +++ b/libdispatch/dattinq.c @@ -39,7 +39,7 @@ doesn't if the attribute was stored without a trailing zero byte, for example from a FORTRAN program. Before using the value as a C string, make sure it is null-terminated. \ref ignored_if_null. -\section Example +\section nc_inq_att_example Example Here is an example using nc_inq_att() to find out the type and length of a variable attribute named valid_range for a netCDF variable named rh diff --git a/libdispatch/dattput.c b/libdispatch/dattput.c index 5928ed0c6..cf2600088 100644 --- a/libdispatch/dattput.c +++ b/libdispatch/dattput.c @@ -96,7 +96,7 @@ is still in initial define mode. _Fill_Value_ attribute, and will tell the HDF5 layer to use the specified fill value for that variable. -\section Example +\section nc_put_att_text_example Example Here is an example using nc_put_att_double() to add a variable attribute named valid_range for a netCDF variable named rh and diff --git a/man4/guide.dox b/man4/guide.dox index 80be8c870..c02cb45df 100644 --- a/man4/guide.dox +++ b/man4/guide.dox @@ -4,8 +4,11 @@ \mainpage +\tableofcontents + \section user_guide The NetCDF User's Guide +- \ref mainpage_netcdf - \subpage netcdf_summary - \subpage netcdf_introduction - \subpage file_structure_and_performance @@ -23,9 +26,7 @@ Data - \ref remote_client - \ref type_conversion -\page netcdf_summary NetCDF Summary - -\tableofcontents +\section netcdf_summary The Purpose of NetCDF The purpose of the Network Common Data Form (netCDF) interface is to allow you to create, access, and share array-oriented data in a form From 0cdd3b70e1fb6da5f58e7327805c6eeb31076883 Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Tue, 4 Mar 2014 16:06:01 -0700 Subject: [PATCH 7/8] Reorganizing documentation into two separate doxygen projects. --- libdispatch/dattput.c | 2 +- libdispatch/dcompound.c | 2 +- libdispatch/ddim.c | 10 +++---- libdispatch/derror.c | 2 +- libdispatch/dvar.c | 4 +-- libdispatch/dvarget.c | 2 +- libdispatch/dvarinq.c | 4 +-- man4/CMakeLists.txt | 66 ++++++++++++++++++++++++++++------------- man4/Doxyfile.guide.in | 4 +-- man4/guide.dox | 14 +++++---- 10 files changed, 68 insertions(+), 42 deletions(-) diff --git a/libdispatch/dattput.c b/libdispatch/dattput.c index cf2600088..272d1f623 100644 --- a/libdispatch/dattput.c +++ b/libdispatch/dattput.c @@ -186,7 +186,7 @@ apply. \returns ::NC_ELATEFILL Fill values must be written while the file is still in initial define mode. -\section Example +\section nc_put_att_double_example Example Here is an example using nc_put_att_double() to add a variable attribute named valid_range for a netCDF variable named rh and diff --git a/libdispatch/dcompound.c b/libdispatch/dcompound.c index 83385cd14..902f0a9e6 100644 --- a/libdispatch/dcompound.c +++ b/libdispatch/dcompound.c @@ -37,7 +37,7 @@ you wish to insert into the compound type. \returns ::NC_EPERM Attempt to write to a read-only file. \returns ::NC_ENOTINDEFINE Not in define mode. -\section Example +\section nc_def_compound_example Example \code struct s1 diff --git a/libdispatch/ddim.c b/libdispatch/ddim.c index acd2c9ab5..bcde1644a 100644 --- a/libdispatch/ddim.c +++ b/libdispatch/ddim.c @@ -90,7 +90,7 @@ unlimited dimensions. \returns ::NC_ENOMEM Memory allocation (malloc) failure \returns ::NC_EPERM Write to read only -\section Example +\section nc_def_dim_example Example Here is an example using nc_def_dim() to create a dimension named lat of length 18 and a unlimited dimension named rec in a new netCDF dataset @@ -176,7 +176,7 @@ the unlimited dimension, this is the number of records written so far. \returns ::NC_EBADID Not a valid ID. \returns ::NC_EBADDIM Invalid dimension ID or name. -\section Example +\section nc_inq_dim_example Example Here is an example using nc_inq_dim() to determine the length of a dimension named lat, and the name and current maximum length of the @@ -241,7 +241,7 @@ with length less than NC_MAX_NAME. \returns ::NC_ENAMEINUSE String match to name in use \returns ::NC_ENOMEM Memory allocation (malloc) failure \returns ::NC_EPERM Write to read only -\section Example +\section nc_rename_dim_example Example Here is an example using nc_rename_dim to rename the dimension lat to latitude in an existing netCDF dataset named foo.nc: @@ -354,7 +354,7 @@ will be null-terminated. Ignored if NULL. \returns ::NC_EBADID Not a valid ID. \returns ::NC_EBADDIM Invalid dimension ID or name. -\section Example +\section nc_inq_dim_example2 Example Here is an example using nc_inq_dim() to determine the length of a dimension named lat, and the name and current maximum length of the @@ -411,7 +411,7 @@ nc_def_dim(). \returns ::NC_EBADID Not a valid ID. \returns ::NC_EBADDIM Invalid dimension ID or name. -\section Example +\section nc_inq_dim_example3 Example Here is an example using nc_inq_dim() to determine the length of a dimension named lat, and the name and current maximum length of the diff --git a/libdispatch/derror.c b/libdispatch/derror.c index c94e55fb1..d3624ba82 100644 --- a/libdispatch/derror.c +++ b/libdispatch/derror.c @@ -67,7 +67,7 @@ function. The error codes are defined in netcdf.h. \returns short string containing error message. -\section Example +\section handle_error_example Example Here is an example of a simple error handling function that uses nc_strerror to print the error message corresponding to the netCDF diff --git a/libdispatch/dvar.c b/libdispatch/dvar.c index eb8c44a8d..199e33594 100644 --- a/libdispatch/dvar.c +++ b/libdispatch/dvar.c @@ -168,7 +168,7 @@ element of the dimids array. \returns ::NC_ENAMEINUSE Name already in use. \returns ::NC_EPERM Attempt to create object in read-only file. -\section Example +\section nc_def_var_example Example Here is an example using nc_def_var to create a variable named rh of type double with three dimensions, time, lat, and lon in a new netCDF @@ -250,7 +250,7 @@ nc_inq_ncid(). \returns ::NC_ENAMEINUSE Name in use. \returns ::NC_ENOMEM Out of memory. -\section Example +\section nc_rename_var_example Example Here is an example using nc_rename_var to rename the variable rh to rel_hum in an existing netCDF dataset named foo.nc: diff --git a/libdispatch/dvarget.c b/libdispatch/dvarget.c index ffe81c7e1..1b3b487cf 100644 --- a/libdispatch/dvarget.c +++ b/libdispatch/dvarget.c @@ -586,7 +586,7 @@ allocated by the user before this function is called. \returns ::NC_EINDEFINE Operation not allowed in define mode. \returns ::NC_EBADID Bad ncid. -\section Example +\section nc_get_vara_double_example Example Here is an example using nc_get_vara_double() to read all the values of the variable named rh from an existing netCDF dataset named diff --git a/libdispatch/dvarinq.c b/libdispatch/dvarinq.c index 3f94770e7..b88760298 100644 --- a/libdispatch/dvarinq.c +++ b/libdispatch/dvarinq.c @@ -31,7 +31,7 @@ ignored_if_null. \returns ::NC_NOERR No error. \returns ::NC_EBADID Bad ncid. -\section Example +\section nc_inq_varid_example4 Example Here is an example using nc_inq_varid to find out the ID of a variable named rh in an existing netCDF dataset named foo.nc: @@ -85,7 +85,7 @@ stored. \ref ignored_if_null. \returns ::NC_EBADID Bad ncid. \returns ::NC_ENOTVAR Invalid variable ID. -\section Example +\section nc_inq_var_example5 Example Here is an example using nc_inq_var() to find out about a variable named rh in an existing netCDF dataset named foo.nc: diff --git a/man4/CMakeLists.txt b/man4/CMakeLists.txt index d81407d17..cc602095a 100644 --- a/man4/CMakeLists.txt +++ b/man4/CMakeLists.txt @@ -7,28 +7,52 @@ INCLUDE_DIRECTORIES(".") # Build doxygen documentation, if need be. ##### IF(BUILD_DOCS) - FIND_PACKAGE(Doxygen) - IF(DOXYGEN_FOUND) - FILE(GLOB COPY_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.html ${CMAKE_CURRENT_SOURCE_DIR}/images ${CMAKE_CURRENT_SOURCE_DIR}/*.doc ${CMAKE_CURRENT_SOURCE_DIR}/*.xml ${CMAKE_CURRENT_SOURCE_DIR}/*.m4 ${CMAKE_CURRENT_SOURCE_DIR}/*.texi) - FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/) - # Copy the image files used by markdown documentation - # manually. - FILE(GLOB IMG_FILES ${CMAKE_CURRENT_BINARY_DIR}/images/*.jpg) - - # Set abs_top_srcdir to work with the autotools - # doxyfile template. - SET(abs_top_srcdir ${CMAKE_SOURCE_DIR}) - CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in - ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) - ADD_CUSTOM_TARGET(doc_all ALL - ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - COMMENT "Generating API Documentation with Doxygen" VERBATIM - ) - FILE(COPY ${IMG_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html) - ENDIF() + FIND_PACKAGE(Doxygen) + IF(DOXYGEN_FOUND) + FILE(GLOB COPY_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.html ${CMAKE_CURRENT_SOURCE_DIR}/images ${CMAKE_CURRENT_SOURCE_DIR}/*.doc ${CMAKE_CURRENT_SOURCE_DIR}/*.xml ${CMAKE_CURRENT_SOURCE_DIR}/*.m4 ${CMAKE_CURRENT_SOURCE_DIR}/*.texi) + FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/) + # Copy the image files used by markdown documentation + # manually. + FILE(GLOB IMG_FILES ${CMAKE_CURRENT_BINARY_DIR}/images/*.jpg) + + # Set abs_top_srcdir to work with the autotools + # doxyfile template. + SET(abs_top_srcdir ${CMAKE_SOURCE_DIR}) + + # Create general and guide doxyfiles. + CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in + ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) + CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.guide.in + ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.guide @ONLY) + + # We need to loop through twice. First to generate tags. + ADD_CUSTOM_TARGET(all_doc_tags ALL + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating API Tags" VERBATIM + ) + ADD_CUSTOM_TARGET(all_doc_tags_guide ALL + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.guide + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating Guide Tags" VERBATIM + ) + + # Second, generate documentation that uses the tags. + ADD_CUSTOM_TARGET(doc_all ALL + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating API Documentation" VERBATIM + ) + ADD_CUSTOM_TARGET(doc_guide ALL + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.guide + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating NetCDF Users Guide" VERBATIM + ) + + FILE(COPY ${IMG_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html) + ENDIF() ENDIF() -SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST} CMakeLists.txt Makefile.am netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html mainpage.doc tutorial.doc install.doc dispatch.doc guide.doc types.doc notes.doc cdl.doc architecture.doc internal.doc Doxyfile.in.cmake windows-binaries.md Building-with-CMake.md) +SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST} CMakeLists.txt Makefile.am netcdf.m4 DoxygenLayout.xml Doxyfile.in Doxyfile.guide.in footer.html mainpage.dox tutorial.dox install.dox dispatch.dox guide.dox types.dox notes.dox cdl.dox architecture.dox internal.dox install-fortran.dox Doxyfile.in.cmake windows-binaries.md Building-with-CMake.md) ADD_EXTRA_DIST("${CUR_EXTRA_DIST}") \ No newline at end of file diff --git a/man4/Doxyfile.guide.in b/man4/Doxyfile.guide.in index 993800c27..c60c2f3e0 100644 --- a/man4/Doxyfile.guide.in +++ b/man4/Doxyfile.guide.in @@ -769,7 +769,7 @@ FILE_PATTERNS = # be searched for input files as well. # The default value is: NO. -RECURSIVE = YES +RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a @@ -811,7 +811,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = @abs_top_srcdir@/examples/C +EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and diff --git a/man4/guide.dox b/man4/guide.dox index c02cb45df..9d833fc03 100644 --- a/man4/guide.dox +++ b/man4/guide.dox @@ -2654,11 +2654,13 @@ The bm_file program is controlled with command line options. file Name of netCDF file -\page netcdf_utilities_guide Netcdf Utilities +\page netcdf_utilities_guide NetCDF Utilities \tableofcontents -\section cdl_syntax CDL Syntax +\section cdl_guide CDL Guide + +\subsection cdl_syntax CDL Syntax Below is an example of CDL, describing a netCDF classic format file with several named dimensions (lat, lon, time), variables (z, t, p, rh, lat, lon, @@ -2798,7 +2800,7 @@ conversions among numeric primitive types are supported. A special notation for fill values is supported: the ‘_’ character designates a fill value for variables. -\section cdl_data_types CDL Data Types +\subsection cdl_data_types CDL Data Types The CDL primitive data types for the classic model are: - char - Characters. @@ -2862,7 +2864,7 @@ encouraged to add the special variable attribute "_Encoding" with a value that the netCDF libraries recognize. Currently those valid values are "UTF-8" or "ASCII", case insensitive. -\section cdl_constants CDL Notation for Data Constants +\subsection cdl_constants CDL Notation for Data Constants This section describes the CDL notation for constants. @@ -2984,7 +2986,7 @@ of constants of user-defined types. \section guide_ncdump ncdump -\brief Convert netCDF file to text form (CDL) +Convert NetCDF file to text form (CDL) \subsection ncdump_SYNOPSIS ncdump synopsis @@ -3255,7 +3257,7 @@ arrays of real strings of varying length. \section guide_nccopy nccopy -\brief Copy a netCDF file, optionally changing format, compression, or chunking in the output. +Copy a netCDF file, optionally changing format, compression, or chunking in the output. \subsection nccopy_SYNOPSIS nccopy synopsis From 084e3d6d8f2d87616278128294114b4dbe8739a1 Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Wed, 5 Mar 2014 14:43:24 -0700 Subject: [PATCH 8/8] Moved .texi documents into an old directory. Pulled the tutorial document into a separate document, similar to the guide document. --- CMakeLists.txt | 6 +- libdispatch/ddim.c | 54 +- libdispatch/derror.c | 11 +- man4/CMakeLists.txt | 12 + man4/Doxyfile.guide.in | 3 +- man4/Doxyfile.in | 22 +- man4/Doxyfile.tutorial.in | 2344 +++++++++++++++++++++++++++ man4/{errors.dox => errors.dox.old} | 0 man4/groups.dox | 58 + man4/mainpage.dox | 2 +- man4/{ => old}/defines.texi | 0 man4/{ => old}/netcdf-c.texi | 0 man4/{ => old}/netcdf-cxx.texi | 0 man4/{ => old}/netcdf-cxx4.texi | 0 man4/{ => old}/netcdf-f77.texi | 0 man4/{ => old}/netcdf-f90.texi | 0 man4/{ => old}/netcdf-install.texi | 0 man4/{ => old}/netcdf-internal.texi | 0 man4/{ => old}/netcdf-tutorial.texi | 0 man4/{ => old}/netcdf.texi | 0 man4/tutorial.dox | 8 +- 21 files changed, 2437 insertions(+), 83 deletions(-) create mode 100644 man4/Doxyfile.tutorial.in rename man4/{errors.dox => errors.dox.old} (100%) create mode 100644 man4/groups.dox rename man4/{ => old}/defines.texi (100%) rename man4/{ => old}/netcdf-c.texi (100%) rename man4/{ => old}/netcdf-cxx.texi (100%) rename man4/{ => old}/netcdf-cxx4.texi (100%) rename man4/{ => old}/netcdf-f77.texi (100%) rename man4/{ => old}/netcdf-f90.texi (100%) rename man4/{ => old}/netcdf-install.texi (100%) rename man4/{ => old}/netcdf-internal.texi (100%) rename man4/{ => old}/netcdf-tutorial.texi (100%) rename man4/{ => old}/netcdf.texi (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 86ef29c94..478c8a55d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -787,9 +787,9 @@ IF(ENABLE_DOXYGEN) # Option to turn on the TODO list in the doxygen-generated documentation. - OPTION(ENABLE_DOXYGEN_TODO_LIST "Turn on todo list in documentation. This is of interest to developers only." OFF) - IF(ENABLE_DOXYGEN_TODO_LIST) - SET(SHOW_DOXYGEN_TODO_LIST YES CACHE STRING "") + OPTION(ENABLE_DOXYGEN_TASKS "Turn on test, todo, bug lists in documentation. This is of interest to developers only." OFF) + IF(ENABLE_DOXYGEN_TASKS) + SET(SHOW_DOXYGEN_TAG_LIST YES CACHE STRING "") ELSE() SET(SHOW_DOXYGEN_TODO_LIST NO CACHE STRING "") ENDIF() diff --git a/libdispatch/ddim.c b/libdispatch/ddim.c index bcde1644a..020302902 100644 --- a/libdispatch/ddim.c +++ b/libdispatch/ddim.c @@ -9,59 +9,11 @@ Research/Unidata. See COPYRIGHT file for more info. #include "ncdispatch.h" -/*! \defgroup dimensions Dimensions - -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. - -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 -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. - -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. - -Operations supported on dimensions are: -- Create a dimension, given its name and length. -- Get a dimension ID from its name. -- Get a dimension's name and length from its ID. -- Rename a dimension. -*/ /**@{*/ -/*! Define a new dimension. The function nc_def_dim adds a new +/*! + +Define a new dimension. The function nc_def_dim adds a new dimension to an open netCDF dataset in define mode. It returns (as an argument) a dimension ID, given the netCDF ID, the dimension name, and the dimension length. At most one unlimited length dimension, called diff --git a/libdispatch/derror.c b/libdispatch/derror.c index d3624ba82..77564d41b 100644 --- a/libdispatch/derror.c +++ b/libdispatch/derror.c @@ -12,10 +12,6 @@ Research/Unidata. See COPYRIGHT file for more info. /* Tell the user the version of netCDF. */ static const char nc_libvers[] = PACKAGE_VERSION " of "__DATE__" "__TIME__" $"; -/** \defgroup lib_version Library Version - Functions related to querying the library version. -*/ - /** \ingroup lib_version Return the library version. @@ -54,9 +50,8 @@ status value. */ -/** -\ingroup error -Given an error number, return an error message. +/*! Given an error number, return an error message. +\addtogroup error This function returns a static reference to an error message string corresponding to an integer netCDF error status or to a system error @@ -67,7 +62,7 @@ function. The error codes are defined in netcdf.h. \returns short string containing error message. -\section handle_error_example Example +\section handle_error_example nc_strerror Example Here is an example of a simple error handling function that uses nc_strerror to print the error message corresponding to the netCDF diff --git a/man4/CMakeLists.txt b/man4/CMakeLists.txt index cc602095a..3e9579aa3 100644 --- a/man4/CMakeLists.txt +++ b/man4/CMakeLists.txt @@ -24,6 +24,8 @@ IF(BUILD_DOCS) ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.guide.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.guide @ONLY) + CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.tutorial.in + ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.tutorial @ONLY) # We need to loop through twice. First to generate tags. ADD_CUSTOM_TARGET(all_doc_tags ALL @@ -36,6 +38,11 @@ IF(BUILD_DOCS) WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating Guide Tags" VERBATIM ) + ADD_CUSTOM_TARGET(all_doc_tags_tutorial ALL + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.tutorial + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating Tutorial Tags" VERBATIM + ) # Second, generate documentation that uses the tags. ADD_CUSTOM_TARGET(doc_all ALL @@ -48,6 +55,11 @@ IF(BUILD_DOCS) WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating NetCDF Users Guide" VERBATIM ) + ADD_CUSTOM_TARGET(doc_tutorial ALL + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.tutorial + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating Tutorial Tags" VERBATIM + ) FILE(COPY ${IMG_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html) ENDIF() diff --git a/man4/Doxyfile.guide.in b/man4/Doxyfile.guide.in index c60c2f3e0..a18116773 100644 --- a/man4/Doxyfile.guide.in +++ b/man4/Doxyfile.guide.in @@ -2003,7 +2003,8 @@ SKIP_FUNCTION_MACROS = YES # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = @CMAKE_CURRENT_BINARY_DIR@/main.tag=../ +TAGFILES = @CMAKE_CURRENT_BINARY_DIR@/main.tag=../ "@CMAKE_CURRENT_BINARY_DIR@/tutorial.tag = ../html_tutorial" + # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to diff --git a/man4/Doxyfile.in b/man4/Doxyfile.in index 4e407491e..9ec1502f8 100644 --- a/man4/Doxyfile.in +++ b/man4/Doxyfile.in @@ -416,7 +416,7 @@ EXTRACT_PACKAGE = NO # included in the documentation. # The default value is: NO. -EXTRACT_STATIC = NO +EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined # locally in source files will be included in the documentation. If set to NO @@ -580,20 +580,20 @@ STRICT_PROTO_MATCHING = NO # documentation. # The default value is: YES. -GENERATE_TODOLIST = @SHOW_DOXYGEN_TODO_LIST@ +GENERATE_TODOLIST = @SHOW_DOXYGEN_TAG_LIST@ # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the # test list. This list is created by putting \test commands in the # documentation. # The default value is: YES. -GENERATE_TESTLIST = YES +GENERATE_TESTLIST = @SHOW_DOXYGEN_TAG_LIST@ # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. -GENERATE_BUGLIST = YES +GENERATE_BUGLIST = @SHOW_DOXYGEN_TAG_LIST@ # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) # the deprecated list. This list is created by putting \deprecated commands in @@ -746,6 +746,7 @@ WARN_LOGFILE = INPUT = \ @abs_top_srcdir@/RELEASE_NOTES.md \ @abs_top_srcdir@/COPYRIGHT \ + @abs_top_srcdir@/man4/groups.dox \ @abs_top_srcdir@/man4/mainpage.dox \ @abs_top_srcdir@/man4/install.md \ @abs_top_srcdir@/man4/install-fortran.md \ @@ -755,21 +756,10 @@ INPUT = \ @abs_top_srcdir@/man4/cdl.dox \ @abs_top_srcdir@/man4/architecture.dox \ @abs_top_srcdir@/man4/internal.dox \ - @abs_top_srcdir@/man4/tutorial.dox \ @abs_top_srcdir@/man4/windows-binaries.md \ @abs_top_srcdir@/man4/all-error-codes.md \ @abs_top_srcdir@/man4/cmake_faq.md \ @abs_top_srcdir@/include/netcdf.h \ - @abs_top_srcdir@/examples/C/simple_xy_wr.c \ - @abs_top_srcdir@/examples/C/simple_xy_rd.c \ - @abs_top_srcdir@/examples/C/sfc_pres_temp_wr.c \ - @abs_top_srcdir@/examples/C/sfc_pres_temp_rd.c \ - @abs_top_srcdir@/examples/C/pres_temp_4D_wr.c \ - @abs_top_srcdir@/examples/C/pres_temp_4D_rd.c \ - @abs_top_srcdir@/examples/C/simple_nc4_wr.c \ - @abs_top_srcdir@/examples/C/simple_nc4_rd.c \ - @abs_top_srcdir@/examples/C/simple_xy_nc4_wr.c \ - @abs_top_srcdir@/examples/C/simple_xy_nc4_rd.c \ @abs_top_srcdir@/libdispatch/dfile.c \ @abs_top_srcdir@/libdispatch/ddim.c \ @abs_top_srcdir@/libdispatch/datt.c \ @@ -2051,7 +2041,7 @@ SKIP_FUNCTION_MACROS = YES # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = @CMAKE_CURRENT_BINARY_DIR@/guide.tag=html_guide/ +TAGFILES = @CMAKE_CURRENT_BINARY_DIR@/guide.tag=html_guide/ "@CMAKE_CURRENT_BINARY_DIR@/tutorial.tag = html_tutorial/" # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to diff --git a/man4/Doxyfile.tutorial.in b/man4/Doxyfile.tutorial.in new file mode 100644 index 000000000..262253423 --- /dev/null +++ b/man4/Doxyfile.tutorial.in @@ -0,0 +1,2344 @@ +# Doxyfile 1.8.3, mixed with 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "The NetCDF-C Tutorial" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = @PACKAGE_VERSION@ + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = ../../man4/netcdf-50x50.png + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# 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 +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# 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 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# 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 +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = @BUILD_INTERNAL_DOCS@ + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = @SHOW_DOXYGEN_TODO_LIST@ + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = @abs_top_srcdir@/man4/DoxygenLayout.xml + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = NO + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = @abs_top_srcdir@/man4/tutorial.dox \ + @abs_top_srcdir@/examples/C/simple_xy_wr.c \ + @abs_top_srcdir@/examples/C/simple_xy_rd.c \ + @abs_top_srcdir@/examples/C/sfc_pres_temp_wr.c \ + @abs_top_srcdir@/examples/C/sfc_pres_temp_rd.c \ + @abs_top_srcdir@/examples/C/pres_temp_4D_wr.c \ + @abs_top_srcdir@/examples/C/pres_temp_4D_rd.c \ + @abs_top_srcdir@/examples/C/simple_nc4_wr.c \ + @abs_top_srcdir@/examples/C/simple_nc4_rd.c \ + @abs_top_srcdir@/examples/C/simple_xy_nc4_wr.c \ + @abs_top_srcdir@/examples/C/simple_xy_nc4_rd.c + + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = @abs_top_srcdir@/examples/C + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = @abs_top_srcdir@/man4/images/chunking2.png \ + @abs_top_srcdir@/man4/images/compatibility3.png \ + @abs_top_srcdir@/man4/images/compression.png \ + @abs_top_srcdir@/man4/images/groups.png \ + @abs_top_srcdir@/man4/images/nc4-model.png \ + @abs_top_srcdir@/man4/images/ncatts.png \ + @abs_top_srcdir@/man4/images/nc-classic-uml.png \ + @abs_top_srcdir@/man4/images/nccoords.png \ + @abs_top_srcdir@/man4/images/ncfile.png \ + @abs_top_srcdir@/man4/images/netcdf_architecture.png \ + @abs_top_srcdir@/man4/images/pnetcdf.png \ + @abs_top_srcdir@/man4/images/deptree.jpg \ + @abs_top_srcdir@/man4/images/InstallTreeWindows.jpg + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +# CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +# CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: 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. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html/html_tutorial + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = @abs_top_srcdir@/man4/footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +# HTML_ALIGN_MEMBERS = YES + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /