Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

9
api/aio.h
View File

@@ -25,8 +25,12 @@
#pragma once
/** @file
*
* This file defines the aio (analog in) interface for libmaa
* @brief Analog input/output
*
* AIO is the anlog input & output interface to libmaa. It is used to read or
* set the voltage applied to an AIO pin.
*
* @snippet analogin_a0.c Interesting
*/
#ifdef __cplusplus
@@ -44,7 +48,8 @@ extern "C" {
#define ADC_SUPPORTED_RESOLUTION_BITS (10)
/**
* Opaque pointer definition to the internal struct _aio
* Opaque pointer definition to the internal struct _aio. This context refers
* to one single AIO pin on the board.
*/
typedef struct _aio* maa_aio_context;