Merge pull request #25 from COVID-19-electronic-health-system/devel

Added new documentation format

README.md

@@ -5,6 +5,7 @@
 </div>
 
 ![panflute tests](https://github.com/COVID-19-electronic-health-system/PanFLUte/workflows/panflute%20tests/badge.svg)
+[![Netlify Status](https://api.netlify.com/api/v1/badges/1d36eea6-7947-41e3-bcce-38e6f9446aee/deploy-status)](https://app.netlify.com/sites/panflute-docs/deploys)
 
 PanFLUte (Pneumonia analyzing node for FLU to everyone) is an open source spirometer.
 It is used to measures the amount of air you're able to breathe in and out.
@@ -15,3 +16,13 @@ It is used to measures the amount of air you're able to breathe in and out.
 2. ```docker build -t panflute:1.0 .```
 3. ```docker run --rm -it --privileged -v /dev/bus/usb:/dev/bus/usb panflute:1.0```
 4. You should now be greeted with a terminal environment, which has all the necessary libraries needed to compile and flash the firmware.
+
+Directory Structure
+------
+    .
+    ├── board               # Code that runs on the ATtiny841
+    └── doc                 # Doxygen documentation folder
+
+## Licensing
+
+This repository and all contributions herein are [licensed under the MIT license](./LICENSE). Please note that, by contributing to this repository, whether via commit, pull request, issue, comment, or in any other fashion, you are explicitly agreeing that all of your contributions will fall under the same permissive license.

board/adc/adc.c

@@ -1,22 +1,17 @@
 #include "../driver/adc.h"
 
-
-
-
 /** @defgroup group1 TinyADC Library
  *  This is a minimal ADC Library with init and read functions only.
  *  @{
  */
 
-/** @brief class C1 in group 1 */
-
+/** Enables ADC. */
 void adcInit(void) { 
-  /// Enables ADC.
   ADCSRA = (1 << ADEN) | (1 << ADSC);
 }
 
+/** Returns calibrated adc values.*/
 float adcRead(void) {
-    /// Returns calibrated adc values. 
     float sum = 0; // Sum of averaged adc values
     int adc_values_arr[N];
     for (int i = 0; i < N; i++) {
@@ -30,3 +25,4 @@ float adcRead(void) {
     return calibrated_adc_value;
 }
 
+/** @} */ // end of group1

board/mpx5100/mpx5100.c

@@ -3,7 +3,7 @@
 
 
 /** @defgroup group2 MPX5100 Library
- *  This is library interfaces with the mpx5100.
+ *  This library interfaces with the MPX5100.
  *  @{
  */
 

board/usart/usart.c

@@ -38,4 +38,5 @@ int print(char c, FILE *stream) {
     UDR0 = c;
     return 0;
 }
-
+
+/** @} */ // end of group3