PIC32

: README

/**@mainpage README

@section intro Introduction

This is the introduction. When we have an architecture, this will be
written accordingly.

@section comp Compilation

Very simple.

@section doc Documentation Standard

@subsection mainHeader Main Header

@verbatim
/**
* @file main.c

* @brief PIC main for the UNISOL project.
*
* This files implements the functionality.
* Mostly uses functions provided by unisol.h

* @author Jorge Azevedo (jorge.azevedo@ua.pt)
* @date March, 2012
*/
@endverbatim

@subsection mainFunction Main Function
@verbatim
/**
* This is the main entry point.
*/
@endverbatim

@subsection hHeader .h Header
@verbatim
/**
* @file unisol.h

* @brief PIC library for the UNISOL project.
*
* This files contains the essential function used
* in the PIC32 for data aquisition. actuation
* and control.

* @author Jorge Azevedo (jorge.azevedo@ua.pt)
* @date March, 2012
*/
@endverbatim

@subsection hFunction .h Functions
@verbatim
/************************************************
* UART functions
***********************************************/

/// Send a string through UART1.
void uart_send_string(const char *string);
@endverbatim

@subsection cFunctions .c Functions
@verbatim
/************************************************
* UART functions
***********************************************/

/**
* Uses UARTSendDataByte to send each string byte untill '\0' is reached.
* e.g.
* @param string The string to send
*/
void uart_send_string(const char *string)
{

@endverbatim

@author Jorge Azevedo (jorge.azevedo@ua.pt)
@date March, 2012*/