From fa4f5f08efb890c14cadd4a4fb3a8066b5c99c5d Mon Sep 17 00:00:00 2001 From: Chris Mayo Date: Sun, 6 Mar 2022 15:05:35 +0000 Subject: [PATCH] Comment Typos (#214) * Example config comment typos * Code comment typos --- EXRAIL2.cpp | 10 +++++----- config.example.h | 8 ++++---- myAutomation.example.h | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/EXRAIL2.cpp b/EXRAIL2.cpp index af6f0a1..737cef6 100644 --- a/EXRAIL2.cpp +++ b/EXRAIL2.cpp @@ -67,11 +67,11 @@ const int16_t HASH_KEYWORD_ROUTES=-3702; // One instance of RMFT clas is used for each "thread" in the automation. // Each thread manages a loco on a journey through the layout, and/or may manage a scenery automation. -// The thrrads exist in a ring, each time through loop() the next thread in the ring is serviced. +// The threads exist in a ring, each time through loop() the next thread in the ring is serviced. // Statics const int16_t LOCO_ID_WAITING=-99; // waiting for loco id from prog track -int16_t RMFT2::progtrackLocoId; // used for callback when detecting a loco on prograck +int16_t RMFT2::progtrackLocoId; // used for callback when detecting a loco on prog track bool RMFT2::diag=false; // RMFT2 * RMFT2::loopTask=NULL; // loopTask contains the address of ONE of the tasks in a ring. RMFT2 * RMFT2::pausingTask=NULL; // Task causing a PAUSE. @@ -870,13 +870,13 @@ void RMFT2::loop2() { break; case OPCODE_AUTOSTART: // Handled only during begin process - case OPCODE_PAD: // Just a padding for previous opcode needing >1 operad byte. + case OPCODE_PAD: // Just a padding for previous opcode needing >1 operand byte. case OPCODE_TURNOUT: // Turnout definition ignored at runtime case OPCODE_SERVOTURNOUT: // Turnout definition ignored at runtime case OPCODE_PINTURNOUT: // Turnout definition ignored at runtime - case OPCODE_ONCLOSE: // Turnout event catcers ignored here + case OPCODE_ONCLOSE: // Turnout event catchers ignored here case OPCODE_ONTHROW: - case OPCODE_ONACTIVATE: // Activate event catcers ignored here + case OPCODE_ONACTIVATE: // Activate event catchers ignored here case OPCODE_ONDEACTIVATE: break; diff --git a/config.example.h b/config.example.h index 731c56c..53d0d55 100644 --- a/config.example.h +++ b/config.example.h @@ -29,7 +29,7 @@ The configuration file for DCC-EX Command Station ///////////////////////////////////////////////////////////////////////////////////// // NOTE: Before connecting these boards and selecting one in this software // check the quick install guides!!! Some of these boards require a voltage -// generating resitor on the current sense pin of the device. Failure to select +// generating resistor on the current sense pin of the device. Failure to select // the correct resistor could damage the sense pin on your Arduino or destroy // the device. // @@ -85,7 +85,7 @@ The configuration file for DCC-EX Command Station // WIFI_PASSWORD is the network password for your home network or if // you want to change the password from default AP mode password // to the AP password you want. -// Your password may not conain ``"'' (double quote, ASCII 0x22). +// Your password may not contain ``"'' (double quote, ASCII 0x22). #define WIFI_PASSWORD "Your network passwd" // // WIFI_HOSTNAME: You probably don't need to change this @@ -137,7 +137,7 @@ The configuration file for DCC-EX Command Station // If you do not need the EEPROM at all, you can disable all the code that saves // data in the EEPROM. You might want to do that if you are in a Arduino UNO // and want to use the EX-RAIL automation. Otherwise you do not have enough RAM -// to do that. Of course, then none of the EEPROM related commands works. +// to do that. Of course, then none of the EEPROM related commands work. // // #define DISABLE_EEPROM @@ -174,7 +174,7 @@ The configuration file for DCC-EX Command Station // If you have issues with that the direction of the accessory commands is // reversed (for example when converting from another CS to DCC-EX) then -// you can use this to revese the sense of all accessory commmands sent +// you can use this to reverse the sense of all accessory commmands sent // over DCC++. This #define likewise inverts the behaviour of the command // for triggering DCC Accessory Decoders, so that generates a // DCC packet with D=1 (close turnout) and generates D=0 diff --git a/myAutomation.example.h b/myAutomation.example.h index f1bad26..4bb6301 100644 --- a/myAutomation.example.h +++ b/myAutomation.example.h @@ -1,7 +1,7 @@ /* This is an automation example file. * The presence of a file called "myAutomation.h" brings EX-RAIL code into * the command station. - * The auotomation may have multiple concurrent tasks. + * The automation may have multiple concurrent tasks. * A task may * - Act as a ROUTE setup macro for a user to drive over * - drive a loco through an AUTOMATION @@ -10,10 +10,10 @@ * At startup, a single task is created to execute the first * instruction after E$XRAIL. * This task may simply follow a route, or may START - * further tasks (thats is.. send a loco out along a route). + * further tasks (that is.. send a loco out along a route). * * Where the loco id is not known at compile time, a new task - * can be creatd with the command: + * can be created with the command: * * * A ROUTE, AUTOMATION or SEQUENCE are internally identical in ExRail terms