Skip to content

Commit

Permalink
Start class doco
Browse files Browse the repository at this point in the history
  • Loading branch information
peteGSX committed Dec 5, 2023
1 parent 04a4d38 commit 6b71217
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/DCCEXInbound.h
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@
3) Use the get... functions to access the parameters.
These parameters are ONLY VALID until you next call parse.
*/

/// @brief Inbound DCC-EX command parser class to parse commands and provide interpreted parameters
class DCCEXInbound {
public:
/// @brief Setup parser once with enough space to handle the maximum number of
Expand Down
3 changes: 3 additions & 0 deletions src/DCCEXLoco.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ enum Facing {
FacingReversed=1,
};

/// @brief Class for a Loco object representing a DCC addressed locomotive
class Loco {
public:
/// @brief Constructor
Expand Down Expand Up @@ -134,6 +135,7 @@ class Loco {
friend class Consist;
};

/// @brief Class to add an additional attribute to a Loco object to specify the direction it is facing in a consist
class ConsistLoco {
public:
/// @brief Constructor
Expand Down Expand Up @@ -169,6 +171,7 @@ class ConsistLoco {

};

/// @brief Class to create a software consist of one or more ConsistLoco objects
class Consist {
public:
/// @brief Constructor
Expand Down
1 change: 1 addition & 0 deletions src/DCCEXRoutes.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ enum RouteType {
RouteTypeAutomation = 'A',
};

/// @brief Class to contain and maintain the various Route attributes and methods
class Route {
public:
/// @brief Constructor
Expand Down
1 change: 1 addition & 0 deletions src/DCCEXTurnouts.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@

#include <Arduino.h>

/// @brief Class to contain and maintain the various Turnout/Point attributes and methods
class Turnout {
public:
/// @brief Constructor
Expand Down
2 changes: 2 additions & 0 deletions src/DCCEXTurntables.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ enum TurntableType {
TurntableTypeUnknown = 9,
};

/// @brief Class to contain and maintain the various Turntable Index attributes and methods associated with a Turntable
class TurntableIndex {
public:
/// @brief Constructor
Expand Down Expand Up @@ -78,6 +79,7 @@ class TurntableIndex {

};

/// @brief Class to contain and maintain the various Turntable attributes and methods
class Turntable {
public:
/// @brief Constructor
Expand Down

0 comments on commit 6b71217

Please sign in to comment.