Private
Public Access
2
0

docs: Add docs/ folder with in depth topics as well as DoxygenLayout.xml file

* C headers now have @briefs and include examples
* Examples have altered 'Interesting' Sections

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2014-05-29 14:51:38 +01:00
parent b9352a9e8c
commit a02923beec
13 changed files with 312 additions and 49 deletions

View File

@@ -26,8 +26,15 @@
/** @file
*
* This file defines the i2c interface for libmaa
* @brief Inter-Integrated Circuit
*
* This file defines the i2c/Iic interface for libmaa. A context represents a
* bus and that bus may contain multiple addresses or i2c slaves. It is
* considered best practice to make sure the address is correct before doing
* any calls on i2c, in case another application or even thread changed the
* addres on that bus. Multiple instances of the same bus can exist.
*
* @snippet i2c_HMC5883L.c Interesting
*/
#ifdef __cplusplus