From a0184d7678dc41527432385d4f718b4d42d72fce Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Wed, 5 Oct 2022 13:31:49 -0600 Subject: [PATCH] Working towards writing the quick start for plugins and integrating it into doxygen. --- docs/Doxyfile.in | 2 +- docs/all-error-codes.md | 2 +- docs/filter_quickstart.md | 9 +++++++++ docs/known_problems.md | 4 +--- 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 6900f274c..60308ab34 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -814,12 +814,12 @@ INPUT = @abs_top_srcdir@/docs/mainpage.dox \ @abs_top_srcdir@/docs/all-error-codes.md \ @abs_top_srcdir@/docs/inmemory.md \ @abs_top_srcdir@/docs/filters.md \ + @abs_top_srcdir@/docs/filter_quickstart.md \ @abs_top_srcdir@/docs/byterange.dox \ @abs_top_srcdir@/docs/nczarr.md \ @abs_top_srcdir@/docs/notes.md \ @abs_top_srcdir@/docs/building-with-cmake.md \ @abs_top_srcdir@/docs/FAQ.md \ - @abs_top_srcdir@/docs/known_problems.md \ @abs_top_srcdir@/docs/COPYRIGHT.md \ @abs_top_srcdir@/docs/credits.md \ @abs_top_srcdir@/docs/tutorial.dox \ diff --git a/docs/all-error-codes.md b/docs/all-error-codes.md index 97bd42147..b80301d16 100644 --- a/docs/all-error-codes.md +++ b/docs/all-error-codes.md @@ -77,7 +77,7 @@ may occur. # NetCDF-4 Error Codes {#nc4-error-codes} NetCDF-4 uses all error codes from NetCDF-3 (see section [NetCDF-3 Error -Codes](#NetCDF_002d3-Error-Codes)). The following additional error codes +Codes](#nc3-error-codes)). The following additional error codes were added for new errors unique to netCDF-4. ~~~~ diff --git a/docs/filter_quickstart.md b/docs/filter_quickstart.md index e69de29bb..4073be02e 100644 --- a/docs/filter_quickstart.md +++ b/docs/filter_quickstart.md @@ -0,0 +1,9 @@ +NetCDF-4 Filter QuickStart +============================== + + + +NetCDF-4 Filter QuickStart {#nc_filters_quickstart} +============================== + +For full Filters documentation, see \ref filters. \ No newline at end of file diff --git a/docs/known_problems.md b/docs/known_problems.md index 07318f2f7..624da8c57 100644 --- a/docs/known_problems.md +++ b/docs/known_problems.md @@ -3,9 +3,7 @@ Known Problems with netCDF 4.3.0 -------------------------------- - -- [clang compiler (default on OSX 10.9 Mavericks) detects error - building ncgen3](#clang-ncgen3) +cd Known Problems with netCDF 4.2 ------------------------------