8000 Full method signatures in header file. · Batlapin/Arduino_STM32@4e820c3 · GitHub
[go: up one dir, main page]

Skip to content

Commit 4e820c3

Browse files
committed
Full method signatures in header file.
<pet peeve> I don't understand why anyone wants to remove useful API information from the header file. CPP files describes implementation details, header files describes the API. </pet peeve>
1 parent b9dbeb6 commit 4e820c3

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

STM32F1/libraries/WireSlave/src/Wire_slave.h

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ class TwoWire: public Stream {
6969
i2c_msg itc_slave_msg;
7070

7171
void (*user_onRequest)(void);
72-
void (*user_onReceive)(int);
72+
void (*user_onReceive)(int quantity);
7373

7474
void allocateRxBuffer(size_t length);
7575
void allocateTxBuffer(size_t length);
@@ -96,47 +96,49 @@ class TwoWire: public Stream {
9696
TwoWire& operator=(TwoWire&&) = delete;
9797

9898
public:
99+
// return the 'Wire' instance (using I2C1)
99100
static TwoWire& getInstance();
100101
#if WIRE_INTERFACES_COUNT > 1
102+
// return the 'Wire1' instance (using I2C2)
101103
static TwoWire& getInstance1();
102104
#endif
103105

104-
void begin();
105-
void begin(uint8_t);
106-
void begin(int);
106+
void begin(); // master mode
107+
void begin(uint8_t myAddress); //slave mode
108+
void begin(int myAddress); //slave mode
107109
void end();
108-
void setClock(uint32_t);
109-
void beginTransmission(uint8_t);
110-
void beginTransmission(int);
110+
void setClock(uint32_t frequencyHz);
111+
void beginTransmission(uint8_t slaveAddress);
112+
void beginTransmission(int slaveAddress);
111113
uint8_t endTransmission(void);
112-
uint8_t endTransmission(uint8_t);
114+
uint8_t endTransmission(uint8_t sendStop);
113115

114-
uint8_t requestFrom(uint8_t, uint8_t);
115-
uint8_t requestFrom(uint8_t, uint8_t, uint8_t);
116-
uint8_t requestFrom(uint8_t, uint8_t, uint32_t, uint8_t, uint8_t);
117-
uint8_t requestFrom(int, int);
118-
uint8_t requestFrom(int, int, int);
116+
uint8_t requestFrom(uint8_t slaveAddress, uint8_t quantity);
117+
uint8_t requestFrom(uint8_t slaveAddress, uint8_t quantity, uint8_t sendStop);
118+
uint8_t requestFrom(uint8_t slaveAddress, uint8_t num_bytes, uint32_t iaddress, uint8_t isize, uint8_t sendStop);
119+
uint8_t requestFrom(int slaveAddress, int quantity);
120+
uint8_t requestFrom(int slaveAddress, int quantity, int sendStop);
119121

120-
virtual size_t write(uint8_t);
121-
virtual size_t write(const uint8_t *, size_t);
122+
virtual size_t write(uint8_t data);
123+
virtual size_t write(const uint8_t *data, size_t quantity);
122124
virtual int available(void);
123125
virtual int read(void);
124126
virtual int peek(void);
125127
virtual void flush(void);
126-
void onReceive(void (*)(int));
128+
void onReceive(void (*)(int quantity));
127129
void onRequest(void (*)(void));
128130

129-
inline size_t write(unsigned long n) {
130-
return write((uint8_t) n);
131+
inline size_t write(unsigned long data) {
132+
return write((uint8_t) data);
131133
}
132-
inline size_t write(long n) {
133-
return write((uint8_t) n);
134+
inline size_t write(long data) {
135+
return write((uint8_t) data);
134136
}
135-
inline size_t write(unsigned int n) {
136-
return write((uint8_t) n);
137+
inline size_t write(unsigned int data) {
138+
return write((uint8_t) data);
137139
}
138-
inline size_t write(int n) {
139-
return write((uint8_t) n);
140+
inline size_t write(int data) {
141+
return write((uint8_t) data);
140142
}
141143
using Print::write;
142144
};

0 commit comments

Comments
 (0)
0