From c9380809aabbe73a6a293a8e586c8732f66384b9 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Fri, 28 Jun 2024 12:23:44 -0700 Subject: [PATCH] [docs] clarify return value of checkConnection() --- RF24Mesh.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/RF24Mesh.h b/RF24Mesh.h index 603adcb..e34663d 100644 --- a/RF24Mesh.h +++ b/RF24Mesh.h @@ -190,7 +190,9 @@ class ESBMesh /** * Tests connectivity of this node to the mesh. * @note If this function fails, address renewal should typically be done. - * @return 1 if connected, 0 if mesh not responding + * @return + * - True if connected. + * - False if not connected, mesh is not responding, or this node is the master node. */ bool checkConnection();