Skip to content

Commit ee876d9

Browse files
committed
Spellchecking comments copied into docs.
1 parent ad025ba commit ee876d9

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

EXRAIL2MacroBase.h

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@
4040
///param linearaddr DCC linear address of accessory
4141

4242
#define AFTER(vpin,timer...)
43-
///brief Wait for sensor activated, then decativated for given time
43+
///brief Wait for sensor activated, then deactivated for given time
4444
///param vpin Virtual Pin number of sensor
45-
///param timer... optional wait in mS, default 500
45+
///param timer... optional wait in ms, default 500
4646

4747
#define AFTEROVERLOAD(track_id)
4848
///brief Wait for overload to be resolved
@@ -87,7 +87,7 @@
8787
///brief Wait for sensor active, with timeout. Use IFTIMEOUT to determine whether the AT was satisfied.
8888
///see IFTIMEOUT
8989
///param vpin Sensor pin number
90-
///param timeout_ms Millseconds to wait before timeout
90+
///param timeout_ms Milliseconds to wait before timeout
9191

9292
#define AUTOMATION(sequence_id,description)
9393
///brief Defines starting point of a sequence that will be shown as an Automation by
@@ -110,11 +110,11 @@
110110
///param msg Quoted message
111111

112112
#define BUILD_CONSIST(loco_id)
113-
//brief Adds a loco to follow the current loco in a consist
114-
//param loco_id may be negative to indicate loco facing backwards
113+
///brief Adds a loco to follow the current loco in a consist
114+
///param loco_id may be negative to indicate loco facing backwards
115115

116116
#define BREAK_CONSIST
117-
//brief Breaks up any consist involving the current loco
117+
///brief Breaks up any consist involving the current loco
118118

119119
#define CALL(sequence_id)
120120
///brief transfer control to another sequence with expectation to return
@@ -136,7 +136,7 @@
136136
///see THROW
137137

138138
#define CONFIGURE_SERVO(vpin,pos1,pos2,profile)
139-
///brief setup servo movement parameters for non-turnout
139+
///brief Set up servo movement parameters for non-turnout
140140
///param vpin must refer to a servo capable pin
141141
///param pos1 SET position of servo
142142
///param pos2 RESET position of servo
@@ -149,7 +149,7 @@
149149
///param subaddr DCC subaddress
150150

151151
#define DCCX_SIGNAL(signal_id,redAspect,amberAspect,greenAspect)
152-
///brief Dfeine advanced DCC accessory signal with aspects
152+
///brief Define advanced DCC accessory signal with aspects
153153
///param signal_id DCC Linear address AND Id used for all signal manipulation commands
154154

155155
#define DCC_TURNTABLE(turntable_id,home,description...)
@@ -175,8 +175,8 @@
175175

176176
#define DELAYRANDOM(mindelay,maxdelay)
177177
///brief Waits for random delay between min and max milliseconds (This is not blocking)
178-
///param mindelay minumum delay in mS
179-
///param maxdelay maximum delay in mS
178+
///param mindelay minimum delay in ms
179+
///param maxdelay maximum delay in ms
180180

181181
#define DONE
182182
///brief Stops task loco (if any) and terminates current task
@@ -211,7 +211,7 @@
211211
///brief obsolete.. no longer needed. Does nothing.
212212

213213
#define EXTT_TURNTABLE(id,vpin,home,description...)
214-
///brief This statement will create the EX‑Turntable turntable/traverser object only, so you will need a separate HAL() statement for an EX‑Turntable device driver.
214+
///brief Defines the EX‑Turntable turntable/traverser object only, so you will need a separate HAL() statement for an EX‑Turntable device driver.
215215
///param homeAngle the angle of the home position, valid angles are 0 - 3600
216216
///param quoted description...
217217

@@ -296,15 +296,15 @@
296296
///see IF
297297

298298
#define IFRANDOM(percent)
299-
///brief randomly satisfield IF at given percent probability
299+
///brief randomly satisfied IF at given percent probability
300300
///see IF
301301

302302
#define IFRED(signal_id)
303303
///brief Checks if given signal is in RED state
304304
///see IF
305305

306306
#define IFSTASH(stash_id)
307-
///brief Checks if given stash entry has a non zero value
307+
///brief Checks if given stash entry has a non-zero value
308308
///see IF
309309

310310
#define IFSTASHED_HERE(stash_id)
@@ -337,7 +337,7 @@
337337
///param mask Binary mask applied to vpin value
338338

339339
#define IFBITMAP_ANY(vpin,mask)
340-
///brief Checks if vpin pseudo-analog value & mask is non zero
340+
///brief Checks if vpin pseudo-analog value & mask is non-zero
341341
///see IF
342342
///param mask Binary mask applied to vpin value
343343

@@ -363,18 +363,18 @@
363363
#define JMRI_SENSOR(vpin,count...)
364364
///brief Defines multiple JMRI `<s>` type sensor feedback definitions each with id matching vpin and INPUT_PULLUP
365365
///param vpin first vpin number
366-
///param count... Number of consecutine VPINS for which to create JMRI sensor feedbacks. Default 1.
366+
///param count... Number of consecutive VPINS for which to create JMRI sensor feedbacks. Default 1.
367367

368368
#define JMRI_SENSOR_NOPULLUP(vpin,count...)
369369
///brief Defines multiple JMRI `<s>` type sensor feedback definitions each with id matching vpin
370370
///param vpin first vpin number
371-
///param count... Number of consecutine VPINS for which to create JMRI sensor feedbacks. Default 1.
371+
///param count... Number of consecutive VPINS for which to create JMRI sensor feedbacks. Default 1.
372372

373373
#define JOIN
374374
///brief Switches PROG track to receive MAIN track DCC packets. (Drive on PROG track)
375375

376376
#define KILLALL
377-
///brief Tertminates all running EXRAIL tasks
377+
///brief Terminates all running EXRAIL tasks
378378

379379
#define LATCH(vpin)
380380
///brief Make all AT/AFTER/IF see vpin as HIGH without checking hardware
@@ -392,12 +392,12 @@
392392
///param msg Quoted text
393393

394394
#define MOMENTUM(accel,decel...)
395-
///brief sets momentum in mS per DCC 127 step for curent loco.
395+
///brief sets momentum in ms per DCC 127 step for current loco.
396396
///param accel Acceleration momentum
397-
///param decel... Braking momantum. (=Acceleration if not given)
397+
///param decel... Braking momentum. (=Acceleration if not given)
398398

399399
#define SCREEN(display,row,msg)
400-
///brief Send message to external display hadlers
400+
///brief Send message to external display handlers
401401
///param display number, 0=local display, others are handled by external
402402
/// displays which may have different display numbers on different devices.
403403
///param msg Quoted text
@@ -436,10 +436,10 @@
436436
///brief Send MERG CBUS ACOF to Adapter
437437

438438
#define ONACON(eventid)
439-
///brief Start task here when ACON for event receied from MERG CBUS
439+
///brief Start task here when ACON for event received from MERG CBUS
440440

441441
#define ONACOF(eventid)
442-
///brief Start task here when ACOF for event receied from MERG CBUS
442+
///brief Start task here when ACOF for event received from MERG CBUS
443443

444444
#define ONACTIVATE(addr,subaddr)
445445
///brief Start task here when DCC Activate sent for short address
@@ -515,11 +515,11 @@
515515
///brief Start task here when sensor changes HIGH to LOW.
516516

517517
#define PAUSE
518-
///brief Pauses all EXRAIL tasks except the curremnt one.
518+
///brief Pauses all EXRAIL tasks except the current one.
519519
/// Other tasks ESTOP their locos until RESUME issued
520520

521521
#define PIN_TURNOUT(id,vpin,description...)
522-
///brief Defines a turnout which operates on a signle pin
522+
///brief Defines a turnout which operates on a single pin
523523
///param description... Quoted text (shown to throttles) or HIDDEN
524524

525525
#define PRINT(msg)
@@ -609,8 +609,8 @@
609609
///param funcmap... Quoted text, optional list of function names separated by / character with momentary function names prefixed with an *.
610610

611611
#define ROUTE(sequence_id,description)
612-
///brief DEfines starting point of a sequence that will appear as a route on throttle buttons.
613-
///param description Quoted text, throttle button capotion.
612+
///brief Defines starting point of a sequence that will appear as a route on throttle buttons.
613+
///param description Quoted text, throttle button caption.
614614

615615
#define ROUTE_ACTIVE(sequence_id)
616616
///brief Tells throttle to display the route button as active
@@ -642,7 +642,7 @@
642642
///param route sequence_id of route, automation or sequence to drive
643643

644644
#define SEQUENCE(sequence_id)
645-
///brief Provides a unique label than can be used to call, follow or start.
645+
///brief Provides a unique label that can be used to call, follow or start.
646646
///see CALL
647647
///see FOLLOW
648648
///see START
@@ -742,22 +742,22 @@
742742
///brief Starts a new task at the given route/animation/sequence
743743

744744
#define START_SHARED(sequence_id)
745-
///brief Starts a new task at the given route/animation/sequence an share current loco with it
745+
///brief Starts a new task at the given route/animation/sequence and share current loco with it
746746

747747
#define START_SEND(sequence_id)
748-
///brief Starts a new task at the given route/animation/sequence an send current loco to it. Remove loco from current task.
748+
///brief Starts a new task at the given route/animation/sequence and send current loco to it. Remove loco from current task.
749749

750750
#define STASH(stash_id)
751-
///brief saves cuttent tasks loco id in the stash array
751+
///brief saves current task's loco id in the stash array
752752
///param stash_id position in stash array to save loco id
753753

754754
#define STEALTH(code...)
755755
///brief Allows for embedding raw C++ code in context of current task.
756-
///param code... c++ code to be executed. This requires intimate understanding of the product acrhitecture.
756+
///param code... c++ code to be executed. This requires intimate understanding of the product architecture.
757757

758758
#define STEALTH_GLOBAL(code...)
759759
///brief Allows for embedding raw c++ code out of context.
760-
///param code... c++ code to be defined. This requires intimate understanding of the product acrhitecture.
760+
///param code... c++ code to be defined. This requires intimate understanding of the product architecture.
761761

762762
#define STOP
763763
///brief Same as SPEED(0)
@@ -783,8 +783,8 @@
783783
///param subaddr DCC accessory subaddress
784784
///param description... Quoted text or HIDDEN, appears on throttle buttons
785785

786-
#define TURNOUTL(tirnout_id,addr,description...)
787-
///brief Defines a DCC accessory turnout with inear address
786+
#define TURNOUTL(turnout_id,addr,description...)
787+
///brief Defines a DCC accessory turnout with linear address
788788
///see TURNOUT
789789
///param turnout_id to be used in THROW/CLOSE etc
790790
///param addr DCC accessory linear address
@@ -813,10 +813,10 @@
813813
///param mask Binary mask to be ANDed with vpin1 value
814814

815815
#define BITMAP_INC(vpin)
816-
///brief Increments poesudo analog value by 1
816+
///brief Increments pseudo analog value by 1
817817

818818
#define BITMAP_DEC(vpin)
819-
///brief Decrements poesudo analog value by 1 (to zero)
819+
///brief Decrements pseudo analog value by 1 (to zero)
820820

821821
#define BITMAP_OR(vpin1,mask)
822822
///brief Performs a bitwise OR operation on the given vpin analog value and mask.

0 commit comments

Comments
 (0)