Skip to content

Commit b7659cd

Browse files
authored
Comment file - can be uncommented by user if desired
1 parent f882d51 commit b7659cd

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

src/SPITransfer.cpp

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#include "Arduino.h"
2-
2+
/* UNCOMMENT FOR USAGE
33
#if not(defined(MBED_H) || defined(__SAM3X8E__) || defined(DISABLE_SPI_SERIALTRANSFER)) // These boards are/will not be supported by SPITransfer.h
44
55
#include "SPITransfer.h"
66
7-
7+
*/
88
/*
99
void SPITransfer::begin(SPIClass &_port, configST configs, const uint8_t &_SS)
1010
Description:
@@ -19,15 +19,15 @@
1919
Return:
2020
-------
2121
* void
22-
*/
22+
*//*
2323
void SPITransfer::begin(SPIClass& _port, const configST configs, const uint8_t& _SS)
2424
{
2525
port = &_port;
2626
packet.begin(configs);
2727
ssPin = _SS;
2828
}
2929
30-
30+
*/
3131
/*
3232
void SPITransfer::begin(SPIClass &_port, const uint8_t &_SS, const bool _debug, Stream &_debugPort)
3333
Description:
@@ -42,15 +42,15 @@ void SPITransfer::begin(SPIClass& _port, const configST configs, const uint8_t&
4242
Return:
4343
-------
4444
* void
45-
*/
45+
*//*
4646
void SPITransfer::begin(SPIClass& _port, const uint8_t& _SS, const bool _debug, Stream& _debugPort)
4747
{
4848
port = &_port;
4949
packet.begin(_debug, _debugPort);
5050
ssPin = _SS;
5151
}
5252
53-
53+
*/
5454
/*
5555
uint8_t SPITransfer::sendData(const uint16_t &messageLen, const uint8_t packetID)
5656
Description:
@@ -64,7 +64,7 @@ void SPITransfer::begin(SPIClass& _port, const uint8_t& _SS, const bool _debug,
6464
Return:
6565
-------
6666
* uint8_t numBytesIncl - Number of payload bytes included in packet
67-
*/
67+
*//*
6868
uint8_t SPITransfer::sendData(const uint16_t& messageLen, const uint8_t packetID)
6969
{
7070
uint8_t numBytesIncl = packet.constructPacket(messageLen, packetID);
@@ -92,7 +92,7 @@ uint8_t SPITransfer::sendData(const uint16_t& messageLen, const uint8_t packetID
9292
return numBytesIncl;
9393
}
9494
95-
95+
*/
9696
/*
9797
uint8_t SPITransfer::available()
9898
Description:
@@ -105,7 +105,7 @@ uint8_t SPITransfer::sendData(const uint16_t& messageLen, const uint8_t packetID
105105
Return:
106106
-------
107107
* uint8_t bytesRead - Num bytes in RX buffer
108-
*/
108+
*//*
109109
uint8_t SPITransfer::available()
110110
{
111111
volatile uint8_t recChar = SPDR;
@@ -115,7 +115,7 @@ uint8_t SPITransfer::available()
115115
return bytesRead;
116116
}
117117
118-
118+
*/
119119
/*
120120
uint8_t SPITransfer::currentPacketID()
121121
Description:
@@ -127,10 +127,11 @@ uint8_t SPITransfer::available()
127127
Return:
128128
-------
129129
* uint8_t - ID of the last parsed packet
130-
*/
130+
*//*
131131
uint8_t SPITransfer::currentPacketID()
132132
{
133133
return packet.currentPacketID();
134134
}
135135
136136
#endif // not (defined(MBED_H) || defined(__SAM3X8E__))
137+
*/

0 commit comments

Comments
 (0)