Craig Evans / Mbed 2 deprecated DocTest

Example of using Doxygen to document a program.

Dependencies:   mbed

Dependents:   Distancesenser

main.h

Committer:
eencae
Date:
2015-03-11
Revision:
1:6fc14cd8ccf1
Parent:
0:b85460bc73b9

File content as of revision 1:6fc14cd8ccf1:

/**
@file main.h
@brief Header file containing functions prototypes, defines and global variables.
@brief Shows examples of creating Doxygen documentation.
@brief Revision 1.0.
@author Craig A. Evans
@date   March 2015
*/

#ifndef MAIN_H
#define MAIN_H

#define PI 3.14159265359

#include "mbed.h"

/**  
@namespace myled
@brief GPIO output for status LED
*/
DigitalOut myled(LED1); 

int printFlag; /*!< print flag set in ISR */

/**
Adds up two integer variables
@param a - integer to add
@param b - integer to add
@returns the sum of a and b
*/
int sum(int a, int b);

#endif