Skip to content

Commit

Permalink
Tweaks on syntax - for doxygen gen'd docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gigapod committed Apr 30, 2024
1 parent a0ead5f commit f0a91e4
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/ar_ibus.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ The general pattern for a device driver implementation that uses the SparkFun To

The first step is to implement a core, platform independent version of the driver that communicates to the target device using the methods of a ```sfeTkIBus``` interface. By limiting use to the IBus interface, the core implementation can use any bus type or platform that implements the sfeTkIBus interface.

>[!IMPORTANT]
> [!IMPORTANT]
> At this level, the driver is only using a ```sfeTkIBus``` interface, not any specific bus implementation.
This driver has the following unique functionality:
Expand All @@ -141,12 +141,12 @@ This driver has the following unique functionality:

#### Simple Example of an Independent Driver Implementation

>[!NOTE]
> [!NOTE]
> This code is **pseudo-code**, used to demonstrate the key concepts of the implementation pattern.
This implementation would take the following form:

```c++
```cpp

class myDriverClass
{
Expand Down Expand Up @@ -205,7 +205,7 @@ The following is an example of an I2C class in Arduino based on the previous pla
> [!NOTE]
> If your device supports repeated starts, make sure to include ```_theI2CBus.setStop(false)``` in your begin function. Otherwise this can cause issues with your device.
```c++
```cpp
class myArduinoDriverI2C : public myDriverClass
{
Expand Down Expand Up @@ -246,7 +246,7 @@ The following is a SPI version of the driver implemented in Arduino. While simil
> [!NOTE]
> This class implements a ```isConnected()``` method that just calls the superclasses ```checkDeviceID()``` method to determine if the device is available on the bus.
```c++
```cpp

class myArduinoDriveSPI : public myDriverClass
{
Expand Down

0 comments on commit f0a91e4

Please sign in to comment.