removed SOFA_READER_MODULE_DEPENDENCIES.md and mentions to it

leomccormack · Nov 17, 2021 · d5d8f60 · d5d8f60
1 parent 8f19dd9
commit d5d8f60
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 66 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,6 @@ To enable optional framework modules, simply add the relevant pre-processor defi
 SAF_ENABLE_SOFA_READER_MODULE  # to enable saf_sofa_reader
 SAF_ENABLE_TRACKER_MODULE      # to enable saf_tracker
 ```
-Note that the **saf_sofa_reader** module also requires [netCDF](https://www.unidata.ucar.edu/software/netcdf/) to be linked to your project. [Instructions on how to install/link this dependency can be found here](docs/SOFA_READER_MODULE_DEPENDENCIES.md). 
 
 ### Additional options
 

diff --git a/docs/SOFA_READER_MODULE_DEPENDENCIES.md b/docs/SOFA_READER_MODULE_DEPENDENCIES.md
diff --git a/framework/include/saf.h b/framework/include/saf.h
@@ -257,7 +257,6 @@
  *       SAF_ENABLE_SOFA_READER_MODULE
  *   Optionally, if SAF_ENABLE_NETCDF is defined, then the netcdf library must
  *   also be linked to your project.
- *   More information can be found in: docs/SOFA_READER_MODULE_DEPENDENCIES.md
  * ## Dependencies
  *   saf_utilities.h, saf_hrir.h, zlib, netcdf (optional)
  *

diff --git a/framework/include/saf_externals.h b/framework/include/saf_externals.h
@@ -275,9 +275,6 @@
  *
  * The "mysofa" interface, e.g. mysofa_load(), may also be used directly in
  * either case.
- *
- * Instructions regarding where to find and how to link the "netcdf" library
- *     can be found in: docs/SOFA_READER_MODULE_DEPENDENCIES.md
  */
 # ifdef SAF_ENABLE_NETCDF
 #  include <netcdf.h>

diff --git a/framework/modules/saf_sofa_reader/saf_sofa_reader.c b/framework/modules/saf_sofa_reader/saf_sofa_reader.c
@@ -19,10 +19,10 @@
  * @ingroup SOFA_Reader
  * @brief Public source for the sofa reader module (#SAF_SOFA_READER_MODULE)
  *
- * @note This (optional) SOFA reader, requires either netcdf (and its
- *       dependencies) or zlib to be linked to your project. Note that zlib is
- *       used by default, unless "SAF_ENABLE_NETCDF" is defined.
- *       Refer to docs/SOFA_READER_MODULE_DEPENDENCIES.md for more information.
+ * @note This SOFA reader may optionally use netcdf if "SAF_ENABLE_NETCDF" is
+ *       defined. Otherwise, the reader will use zlib, which is included in
+ *       framework/resources/zlib; in which case, no external libraries need to
+ *       be linked.
  *
  * @author Leo McCormack
  * @date 21.11.2017

diff --git a/framework/modules/saf_sofa_reader/saf_sofa_reader.h b/framework/modules/saf_sofa_reader/saf_sofa_reader.h
@@ -20,10 +20,10 @@
  * @file saf_sofa_reader.h 
  * @brief Main header for the sofa reader module (#SAF_SOFA_READER_MODULE)
  *
- * @note This (optional) SOFA reader, requires netcdf (and its dependencies)
- *       and/or zlib to be linked to your project. Note that zlib is used by
- *       default, unless "SAF_ENABLE_NETCDF" is defined.
- *       Refer to docs/SOFA_READER_MODULE_DEPENDENCIES.md for more information.
+ * @note This SOFA reader may optionally use netcdf if "SAF_ENABLE_NETCDF" is
+ *       defined. Otherwise, the reader will use zlib, which is included in
+ *       framework/resources/zlib; in which case, no external libraries need to
+ *       be linked.
  *
  * @author Leo McCormack
  * @date 21.11.2017