From 91745599c18034dcc0652f8f9297df9ec25e6add Mon Sep 17 00:00:00 2001
From: Brendan <2bndy5@gmail.com>
Date: Tue, 5 Mar 2024 10:38:14 -0800
Subject: [PATCH] reviewed files' doc comment at beginning of examples

---
 examples/scanner/scanner.ino               |  2 ++
 examples/scannerGraphic/scannerGraphic.ino |  2 ++
 examples_linux/ncurses/scanner_curses.cpp  | 10 ++++++++++
 examples_linux/scanner.cpp                 |  2 ++
 examples_linux/scanner.py                  |  8 +++++++-
 5 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/examples/scanner/scanner.ino b/examples/scanner/scanner.ino
index 1ad2b4e9..c54e3e59 100644
--- a/examples/scanner/scanner.ino
+++ b/examples/scanner/scanner.ino
@@ -22,6 +22,8 @@
  *
  * Inspired by cpixip.
  * See https://forum.arduino.cc/t/poor-mans-2-4-ghz-scanner/54846
+ *
+ * See documentation at https://nRF24.github.io/RF24
  */
 
 /*
diff --git a/examples/scannerGraphic/scannerGraphic.ino b/examples/scannerGraphic/scannerGraphic.ino
index 26005f16..566cb075 100644
--- a/examples/scannerGraphic/scannerGraphic.ino
+++ b/examples/scannerGraphic/scannerGraphic.ino
@@ -32,6 +32,8 @@
  *     convenience set radio data rate or further development. See our other
  *     RF24/scanner example that only uses the Serial Monitor instead of a graphic
  *     display.
+ *
+ * See documentation at https://nRF24.github.io/RF24
  */
 #include <Adafruit_GFX.h>  // dependency of Adafruit display libraries
 #include "RF24.h"
diff --git a/examples_linux/ncurses/scanner_curses.cpp b/examples_linux/ncurses/scanner_curses.cpp
index 2e6b3c0c..54fc9cd9 100644
--- a/examples_linux/ncurses/scanner_curses.cpp
+++ b/examples_linux/ncurses/scanner_curses.cpp
@@ -5,6 +5,16 @@
  modify it under the terms of the GNU General Public License
  version 2 as published by the Free Software Foundation.
  */
+
+/**
+ * Channel scanner
+ *
+ * Example to detect interference on the various channels available.
+ * This is a good diagnostic tool to check whether you're picking a
+ * good channel for your application.
+ *
+ * See documentation at https://nRF24.github.io/RF24
+ */
 #include <cstdio>   // sprintf()
 #include <string>   // string, getline()
 #include <ctime>    // time_t, time(), difftime()
diff --git a/examples_linux/scanner.cpp b/examples_linux/scanner.cpp
index ce68b92e..7de43043 100644
--- a/examples_linux/scanner.cpp
+++ b/examples_linux/scanner.cpp
@@ -21,6 +21,8 @@
  *
  * Inspired by cpixip.
  * See https://forum.arduino.cc/t/poor-mans-2-4-ghz-scanner/54846
+ *
+ * See documentation at https://nRF24.github.io/RF24
  */
 
 /*
diff --git a/examples_linux/scanner.py b/examples_linux/scanner.py
index 4d191a79..f1debb1f 100644
--- a/examples_linux/scanner.py
+++ b/examples_linux/scanner.py
@@ -1,4 +1,10 @@
-"""A scanner example written in python using the std lib's ncurses wrapper."""
+"""A scanner example written in python using the std lib's ncurses wrapper.
+
+This is a good diagnostic tool to check whether you're picking a
+good channel for your application.
+
+See documentation at https://nRF24.github.io/RF24
+"""
 
 # pylint: disable=no-member
 import curses