[docs] clarify return value of checkConnection()

nRF24 · Jun 28, 2024 · c938080 · c938080
1 parent 7f78b0b
commit c938080
Showing 1 changed file with 3 additions and 1 deletion.
diff --git 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();