Skip to content

Commit

Permalink
some tweaks/flesh-out the comment headers
Browse files Browse the repository at this point in the history
  • Loading branch information
gigapod committed Apr 29, 2024
1 parent 266057f commit 2e65cd4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/sfeTk/sfeTkIBus.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#pragma once

#include "sfeTkError.h"
#include <stddef.h>

// Define our error codes for the bus. Note Errors are negative, warnings/info positive
// BUT keep the same increment on the base
Expand Down
10 changes: 10 additions & 0 deletions src/sfeTk/sfeTkII2C.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#include "sfeTkIBus.h"

/**
* @brief Interface that defines the I2C communication bus for the SparkFun Electronics Toolkit.
*
* The I2C bus interface extends the IBus interface and adds the ability to set and get the I2C
* address and stop flag.
*/
class sfeTkII2C : public sfeTkIBus
{
public:
Expand Down Expand Up @@ -72,6 +78,7 @@ class sfeTkII2C : public sfeTkIBus
/*--------------------------------------------------------------------------
@brief setter for I2C stop message (vs restarts)
@param stop The value to set for "send stop"
*/
virtual void setStop(bool stop)
{
Expand All @@ -89,6 +96,9 @@ class sfeTkII2C : public sfeTkIBus
return _stop;
}

/*
* @brief kNoAddress is a constant to indicate no address has been set
*/
static constexpr uint8_t kNoAddress = 0;

private:
Expand Down

0 comments on commit 2e65cd4

Please sign in to comment.