Improving documentation

This commit is contained in:
Rodrigo Alfonso
2024-08-26 07:04:53 -03:00
parent adb1b3802b
commit fa9923cd9d
3 changed files with 6 additions and 6 deletions

View File

@@ -14,7 +14,7 @@
// linkCube->activate();
// - 4) Send 32-bit values:
// linkCube->send(0x12345678);
// // (now linkCube->pendingCount() will be 1 until it's actually sent)
// // (now linkCube->pendingCount() will be 1 until the value is sent)
// - 5) Read 32-bit values:
// if (linkCube->canRead()) {
// u32 value = linkCube->read();

View File

@@ -2,7 +2,7 @@
#define LINK_GPIO_H
// --------------------------------------------------------------------------
// A GPIO handler for the Link Port.
// A General Purpose Input-Output handler for the Link Port.
// --------------------------------------------------------------------------
// Usage:
// - 1) Include this header in your main.cpp file and add:
@@ -27,7 +27,7 @@
#include "_link_common.hpp"
/**
* @brief A GPIO handler for the Link Port.
* @brief A General Purpose Input-Output handler for the Link Port.
*/
class LinkGPIO {
private:

View File

@@ -465,9 +465,9 @@ class LinkUniversal {
void receiveCableMessages() {
static constexpr u32 MAX_PLAYERS =
LINK_CABLE_MAX_PLAYERS < LINK_UNIVERSAL_MAX_PLAYERS
? LINK_CABLE_MAX_PLAYERS
: LINK_UNIVERSAL_MAX_PLAYERS;
LINK_UNIVERSAL_MAX_PLAYERS < LINK_CABLE_MAX_PLAYERS
? LINK_UNIVERSAL_MAX_PLAYERS
: LINK_CABLE_MAX_PLAYERS;
for (u32 i = 0; i < MAX_PLAYERS; i++) {
while (linkCable->canRead(i))