Remove redundant example docs

Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
EnviroDIY · Aug 15, 2024 · da58b30 · da58b30
1 parent 8ecaa7f
commit da58b30
Show file tree

Hide file tree

Showing 16 changed files with 70 additions and 76 deletions.
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -547,13 +547,13 @@ EXTRACT_ALL            = NO
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = YES
+EXTRACT_PRIVATE        = NO
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIV_VIRTUAL   = YES
+EXTRACT_PRIV_VIRTUAL   = NO
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -1059,6 +1059,8 @@ EXCLUDE                = ../src/ReadMe.md \
                          ../examples/logger_test \
                          ../examples/logger_test_nonew \
                          ../examples/YosemitechDO \
+                         ../examples/DRWI_2024_CTDandClarivue_LTE_20240724 \
+                         ../examples/DRWI_Mayfly1_Wifi_5tm_ds18b20_1 \
                          ../src/sensors/table.md \
                          ../lib \
                          ../boards \

diff --git a/examples/DRWI_2G/DRWI_2G.ino b/examples/DRWI_2G/DRWI_2G.ino
@@ -5,6 +5,10 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example for DRWI CitSci 2G sites.
+ *
+ * See [the walkthrough page](@ref example_drwi_2g) for detailed instructions.
+ *
+ * @m_examplenavigation{example_drwi_2g,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/DRWI_DigiLTE/DRWI_DigiLTE.ino b/examples/DRWI_DigiLTE/DRWI_DigiLTE.ino
@@ -5,6 +5,11 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example for DRWI CitSci LTE sites.
+ *
+ * See [the walkthrough page](@ref example_drwi_digilte) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_drwi_digilte,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/DRWI_Mayfly1/DRWI_Mayfly1.ino b/examples/DRWI_Mayfly1/DRWI_Mayfly1.ino
@@ -11,6 +11,11 @@
  * Mayfly v1.0 board
  * EnviroDIY SIM7080 LTE module (with Hologram SIM card)
  * Hydros21 CTD sensor
+ *
+ * See [the walkthrough page](@ref example_drwi_mayfly1) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_drwi_mayfly1,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/DRWI_NoCellular/DRWI_NoCellular.ino b/examples/DRWI_NoCellular/DRWI_NoCellular.ino
@@ -5,6 +5,11 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example for DRWI CitSci without cellular service.
+ *
+ * See [the walkthrough page](@ref example_drwi_no_cell) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_drwi_no_cell,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/DRWI_SIM7080LTE/DRWI_SIM7080LTE.ino b/examples/DRWI_SIM7080LTE/DRWI_SIM7080LTE.ino
@@ -12,6 +12,11 @@
  * EnviroDIY SIM7080 LTE module (with Hologram SIM card)
  * Hydros21 CTD sensor
  * Campbell Scientific OBS3+ Turbidity sensor
+ *
+ * See [the walkthrough page](@ref example_drwi_ediylte) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_drwi_ediylte,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/baro_rho_correction/baro_rho_correction.ino b/examples/baro_rho_correction/baro_rho_correction.ino
@@ -5,6 +5,10 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example demonstrating calculated variables.
+ *
+ * See [the walkthrough page](@ref example_baro_rho) for detailed instructions.
+ *
+ * @m_examplenavigation{example_baro_rho,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/data_saving/data_saving.ino b/examples/data_saving/data_saving.ino
@@ -5,6 +5,11 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example publishing only a portion of the logged variables.
+ *
+ * See [the walkthrough page](@ref example_data_saving) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_data_saving,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/double_logger/double_logger.ino b/examples/double_logger/double_logger.ino
@@ -5,6 +5,11 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example logging at two different timing intervals
+ *
+ * See [the walkthrough page](@ref example_double_log) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_double_log,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/examples.dox b/examples/examples.dox
@@ -7,22 +7,6 @@
  * @m_innerpage{example_simple_logging}
  * @m_innerpage{example_learn_envirodiy}
  */
-/**
- * @example{lineno} single_sensor.ino @m_examplenavigation{example_single_sensor,} @m_footernavigation
- * @brief An example using only sensor functions and no logging.
- * See [the walkthrough page](@ref example_single_sensor) for detailed instructions.
- */
-/**
- * @example{lineno} simple_logging.ino @m_examplenavigation{example_simple_logging,} @m_footernavigation
- * @brief A simple data logging example.
- * See [the walkthrough page](@ref example_simple_logging) for detailed instructions.
- */
-/**
- * @example{lineno} simple_logging_LearnEnviroDIY.ino @m_examplenavigation{example_learn_envirodiy,} @m_footernavigation
- * @brief A data logging example for the Learn EnviroDIY tutorial.
- * See [the walkthrough page](@ref example_learn_envirodiy) for detailed instructions.
- */
-
 
 /**
  * @page page_the_examples
@@ -32,17 +16,6 @@
  * @m_innerpage{example_mmw}
  * @m_innerpage{example_thingspeak}
  */
-/**
- * @example{lineno} logging_to_MMW.ino @m_examplenavigation{example_mmw,} @m_footernavigation
- * @brief Example logging data and publishing to Monitor My Watershed.
- * See [the walkthrough page](@ref example_mmw) for detailed instructions.
- */
-/**
- * @example{lineno} logging_to_ThingSpeak.ino @m_examplenavigation{example_thingspeak,} @m_footernavigation
- * @brief Example logging data and publishing to ThingSpeak.
- * See [the walkthrough page](@ref example_thingspeak) for detailed instructions.
- */
-
 
 /**
  * @page page_the_examples
@@ -53,22 +26,6 @@
  * @m_innerpage{example_double_log}
  * @m_innerpage{example_data_saving}
  */
-/**
- * @example{lineno} baro_rho_correction.ino @m_examplenavigation{example_baro_rho,} @m_footernavigation
- * @brief Example demonstrating calculated variables.
- * See [the walkthrough page](@ref example_baro_rho) for detailed instructions.
- */
-/**
- * @example{lineno} double_logger.ino @m_examplenavigation{example_double_log,} @m_footernavigation
- * @brief Example logging at two different timing intervals
- * See [the walkthrough page](@ref example_double_log) for detailed instructions.
- */
-/**
- * @example{lineno} data_saving.ino @m_examplenavigation{example_data_saving,} @m_footernavigation
- * @brief Example publishing only a portion of the logged variables.
- * See [the walkthrough page](@ref example_data_saving) for detailed instructions.
- */
-
 
 /**
  * @page page_the_examples
@@ -81,32 +38,6 @@
  * @m_innerpage{example_drwi_2g}
  * @m_innerpage{example_drwi_no_cell}
  */
-/**
- * @example{lineno} DRWI_Mayfly1.ino @m_examplenavigation{example_drwi_mayfly1,} @m_footernavigation
- * @brief Example for DRWI CitSci LTE sites with a Mayfly 1.x utilizing on-board sensors.
- * See [the walkthrough page](@ref example_drwi_mayfly1) for detailed instructions.
- */
-/**
- * @example{lineno} DRWI_SIM7080LTE.ino @m_examplenavigation{example_drwi_ediylte,} @m_footernavigation
- * @brief Example for DRWI CitSci LTE sites.
- * See [the walkthrough page](@ref example_drwi_ediylte) for detailed instructions.
- */
-/**
- * @example{lineno} DRWI_DigiLTE.ino @m_examplenavigation{example_drwi_digilte,} @m_footernavigation
- * @brief Example for DRWI CitSci LTE sites.
- * See [the walkthrough page](@ref example_drwi_digilte) for detailed instructions.
- */
-/**
- * @example{lineno} DRWI_2G.ino @m_examplenavigation{example_drwi_2g,} @m_footernavigation
- * @brief Example for DRWI CitSci 2G sites.
- * See [the walkthrough page](@ref example_drwi_2g) for detailed instructions.
- */
-/**
- * @example{lineno} DRWI_NoCellular.ino @m_examplenavigation{example_drwi_no_cell,} @m_footernavigation
- * @brief Example for DRWI CitSci without cellular service.
- * See [the walkthrough page](@ref example_drwi_no_cell) for detailed instructions.
- */
-
 
 /**
  * @page page_the_examples
@@ -115,8 +46,3 @@
  * [Everything at Once - a la carte](@ref examples_everything)
  * @m_innerpage{example_menu}
  */
-/**
- * @example{lineno} menu_a_la_carte.ino @m_examplenavigation{example_menu,} @m_footernavigation
- * @brief Example with all possible functionality.
- * See [the walkthrough page](@ref example_menu) for detailed instructions.
- */
diff --git a/examples/logging_to_MMW/logging_to_MMW.ino b/examples/logging_to_MMW/logging_to_MMW.ino
@@ -5,6 +5,10 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example logging data and publishing to Monitor My Watershed.
+ *
+ * See [the walkthrough page](@ref example_mmw) for detailed instructions.
+ *
+ * @m_examplenavigation{example_mmw,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/logging_to_ThingSpeak/logging_to_ThingSpeak.ino b/examples/logging_to_ThingSpeak/logging_to_ThingSpeak.ino
@@ -5,6 +5,11 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example logging data and publishing to ThingSpeak.
+ *
+ * See [the walkthrough page](@ref example_thingspeak) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_thingspeak,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/menu_a_la_carte/menu_a_la_carte.ino b/examples/menu_a_la_carte/menu_a_la_carte.ino
@@ -5,6 +5,10 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief Example with all possible functionality.
+ *
+ * See [the walkthrough page](@ref example_menu) for detailed instructions.
+ *
+ * @m_examplenavigation{example_menu,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/simple_logging/simple_logging.ino b/examples/simple_logging/simple_logging.ino
@@ -5,6 +5,11 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief A simple data logging example.
+ *
+ * See [the walkthrough page](@ref example_simple_logging) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_simple_logging,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/simple_logging_LearnEnviroDIY/simple_logging_LearnEnviroDIY.ino b/examples/simple_logging_LearnEnviroDIY/simple_logging_LearnEnviroDIY.ino
@@ -5,6 +5,11 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief A data logging example for the Learn EnviroDIY tutorial.
+ *
+ * See [the walkthrough page](@ref example_learn_envirodiy) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_learn_envirodiy,}
  * ======================================================================= */
 
 // ==========================================================================

diff --git a/examples/single_sensor/single_sensor.ino b/examples/single_sensor/single_sensor.ino
@@ -5,6 +5,11 @@
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
  * @brief An example using only sensor functions and no logging.
+ *
+ * See [the walkthrough page](@ref example_single_sensor) for detailed
+ * instructions.
+ *
+ * @m_examplenavigation{example_single_sensor,}
  * ======================================================================= */
 
 // ==========================================================================