Reorder example headers

Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>

ChangeLog.md

@@ -1,9 +1,9 @@
 # ChangeLog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
-and its stricter, better defined, brother [Common Changelog](https://common-changelog.org/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and its stricter, better defined, brother [Common Changelog](https://common-changelog.org/).
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ***
 

examples/DRWI_2G/DRWI_2G.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file DRWI_2G.ino
- * @brief Example for DRWI CitSci 2G sites.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} DRWI_2G.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example for DRWI CitSci 2G sites.
  * ======================================================================= */
 
 // ==========================================================================

examples/DRWI_DigiLTE/DRWI_DigiLTE.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file DRWI_DigiLTE.ino
- * @brief Example for DRWI CitSci LTE sites.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} DRWI_DigiLTE.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example for DRWI CitSci LTE sites.
  * ======================================================================= */
 
 // ==========================================================================

examples/DRWI_Mayfly1/DRWI_Mayfly1.ino

@@ -1,22 +1,16 @@
 /** =========================================================================
- * @file DRWI_Mayfly1.ino
+ * @example{lineno} DRWI_Mayfly1.ino
+ * @copyright Stroud Water Research Center
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ *
  * @brief Example for DRWI CitSci LTE sites.
  *
  * This example shows proper settings for the following configuration:
  *
  * Mayfly v1.0 board
  * EnviroDIY SIM7080 LTE module (with Hologram SIM card)
  * Hydros21 CTD sensor
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
- * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
-
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
- *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
  * ======================================================================= */
 
 // ==========================================================================

examples/DRWI_Mayfly1_WiFi/DRWI_Mayfly1_WiFi.ino

@@ -1,22 +1,16 @@
 /** =========================================================================
- * @file DRWI_Mayfly1_WiFi.ino
+ * @example{lineno} DRWI_Mayfly1_WiFi.ino
+ * @copyright Stroud Water Research Center
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ *
  * @brief Example for DRWI CitSci LTE sites.
  *
  * This example shows proper settings for the following configuration:
  *
  * Mayfly v1.x board
  * EnviroDIY ESP32 Wifi Bee module
  * Hydros21 CTD sensor
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
- * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
-
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
- *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
  * ======================================================================= */
 
 // ==========================================================================

examples/DRWI_NoCellular/DRWI_NoCellular.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file DRWI_NoCellular.ino
- * @brief Example for DRWI CitSci without cellular service.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} DRWI_NoCellular.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example for DRWI CitSci without cellular service.
  * ======================================================================= */
 
 // ==========================================================================

examples/DRWI_SIM7080LTE/DRWI_SIM7080LTE.ino

@@ -1,5 +1,9 @@
 /** =========================================================================
- * @file DRWI_SIM7080LTE.ino
+ * @example{lineno} DRWI_SIM7080LTE.ino
+ * @copyright Stroud Water Research Center
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ *
  * @brief Example for DRWI CitSci LTE sites.
  *
  * This example shows proper settings for the following configuration:
@@ -8,16 +12,6 @@
  * EnviroDIY SIM7080 LTE module (with Hologram SIM card)
  * Hydros21 CTD sensor
  * Campbell Scientific OBS3+ Turbidity sensor
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
- * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
-
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
- *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
  * ======================================================================= */
 
 // ==========================================================================

examples/baro_rho_correction/baro_rho_correction.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file baro_rho_correction.ino
- * @brief Example demonstrating calculated variables.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} baro_rho_correction.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example demonstrating calculated variables.
  * ======================================================================= */
 
 // ==========================================================================

examples/data_saving/data_saving.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file data_saving.ino
- * @brief Example publishing only a portion of the logged variables.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} data_saving.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example publishing only a portion of the logged variables.
  * ======================================================================= */
 
 // ==========================================================================

examples/double_logger/double_logger.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file double_logger.ino
- * @brief Example logging at two different timing intervals
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} double_logger.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example logging at two different timing intervals
  * ======================================================================= */
 
 // ==========================================================================

examples/logging_to_MMW/logging_to_MMW.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file logging_to_MMW.ino
- * @brief Example logging data and publishing to Monitor My Watershed.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} logging_to_MMW.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example logging data and publishing to Monitor My Watershed.
  * ======================================================================= */
 
 // ==========================================================================

examples/logging_to_ThingSpeak/logging_to_ThingSpeak.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file logging_to_ThingSpeak.ino
- * @brief Example logging data and publishing to ThingSpeak.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} logging_to_ThingSpeak.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example logging data and publishing to ThingSpeak.
  * ======================================================================= */
 
 // ==========================================================================

examples/menu_a_la_carte/menu_a_la_carte.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file menu_a_la_carte.ino
- * @brief Example with all possible functionality.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} menu_a_la_carte.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief Example with all possible functionality.
  * ======================================================================= */
 
 // ==========================================================================

examples/simple_logging/simple_logging.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file simple_logging.ino
- * @brief A simple data logging example.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} simple_logging.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief A simple data logging example.
  * ======================================================================= */
 
 // ==========================================================================

examples/simple_logging_LearnEnviroDIY/simple_logging_LearnEnviroDIY.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file simple_logging_LearnEnviroDIY.ino
- * @brief A data logging example for the Learn EnviroDIY tutorial.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} simple_logging_LearnEnviroDIY.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief A data logging example for the Learn EnviroDIY tutorial.
  * ======================================================================= */
 
 // ==========================================================================

examples/single_sensor/single_sensor.ino

@@ -1,16 +1,10 @@
 /** =========================================================================
- * @file single_sensor.ino
- * @brief An example using only sensor functions and no logging.
- *
- * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
+ * @example{lineno} single_sensor.ino
  * @copyright Stroud Water Research Center
- * This example is published under the BSD-3 license.
- *
- * Build Environment: Visual Studio Code with PlatformIO
- * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
+ * @license This example is published under the BSD-3 license.
+ * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
  *
- * DISCLAIMER:
- * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
+ * @brief An example using only sensor functions and no logging.
  * ======================================================================= */
 
 // ==========================================================================