Ichiro Maruta / SoftwareI2C

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of SoftwareI2C by Chris Pepper

Files at this revision

API Documentation at this revision

Revision 1:6966eacc5914, committed 2012-04-01

Comitter:
p3p
Date:
Sun Apr 01 19:27:03 2012 +0000
Parent:
0:6f6cfcdfe3d8
Child:
2:8670e78c4b63
Commit message:
Documentation Fix

Changed in this revision

SoftwareI2C.cpp Show annotated file Show diff for this revision Revisions of this file 
--- a/SoftwareI2C.cpp	Sun Apr 01 19:21:03 2012 +0000
+++ b/SoftwareI2C.cpp	Sun Apr 01 19:27:03 2012 +0000
@@ -6,7 +6,7 @@
 
 #include "SoftwareI2C.h"
 
-/*
+/**
  * @brief Initializes interface
  * @param sda GPIO pin to use as I2C SDA
  * @param scl GPIO pin to use as I2C SCL
@@ -27,7 +27,7 @@
 
 }
 
-/*
+/**
  * @brief Read 1 or more bytes from the I2C slave
  * @param device_address The address of the device to read from
  * @param data An allocated array to read the data into
@@ -49,7 +49,7 @@
     stop();
 }
 
-/*
+/**
  * @brief Write 1 or more bytes to the I2C slave
  * @param device_address The address of the device to write to
  * @param data An array to write the data from
@@ -69,7 +69,7 @@
     stop();
 }
 
-/*
+/**
  * @brief Write 1 byte to the I2C slave
  * @param device_address The address of the device to write to
  * @param byte The data to write
@@ -84,7 +84,7 @@
     stop();
 }
 
-/*
+/**
  * @brief Read 1 or more bytes from the I2C slave at the specified memory address
  * @param device_address The address of the device to read from
  * @param start_address The memory address to read from
@@ -118,7 +118,7 @@
     stop();
 }
 
-/*
+/**
  * @brief Write 1 byte to the I2C slave at the specified memory address
  * @param device_address The address of the device to write to
  * @param start_address The memory address to write to
@@ -136,7 +136,7 @@
     stop();
 }
 
-/*
+/**
  * @brief Write 1 or more bytes to the I2C slave at the specified memory address
  * @param device_address The address of the device to write to
  * @param start_address The memory address to write to
@@ -159,7 +159,7 @@
     stop();
 }
 
-/*
+/**
  * @brief Read 2 bytes from the I2C slave at the specified memory address and return them as an 16bit unsigned integer
  * @param device_address The address of the device to read from
  * @param start_address The memory address to read from
@@ -175,7 +175,7 @@
     return value;
 }
 
-/*
+/**
  * @brief Read 3 bytes from the I2C slave at the specified memory address and return them as an 32bit unsigned integer
  * @param device_address The address of the device to read from
  * @param start_address The memory address to read from
@@ -192,7 +192,7 @@
     return value;
 }
 
-/*
+/**
  * @brief Read 4 bytes from the I2C slave at the specified memory address and return them as an 32bit unsigned integer
  * @param device_address The address of the device to read from
  * @param start_address The memory address to read from