Documenting Source Code; From The Body Surface Peripherals; Ecg: Electrical Manifestation Of Heart Activity Recorded; Monitoring Of Heart Rate - STMicroelectronics STM32 Cortex-M3 Manual

3.12 Documenting Source Code

2 Electrocardiogram (Ecg) Signals
Documenting the source code is very important that other users of the code are able to understand
it. In this documentation Doxygen has been used. Listing
Doxygen. After running Doxygen a html help is generated. It is stored at
CD:/code/doc/html/index.html.
The Electrocardiogram (Ecg)

• Ecg: electrical manifestation of heart activity recorded

/
@ f i l e u s a r t 1 . c
from the body surface
@ b r i e f USART usage f o r STM32 : putChar ( ) .
4

• monitoring of heart rate

H3 P r o j e c t : u s a r t 1 /H3
Sends p e r i o d i c a l l y t h e c h a r a c t e r ' ' with 9600Baud t o i t s h o s t .
S e t t i n g s ( s e e C o n f i g u r a t i o n Wizard o f STM32 Init ) :
The Ecg signal can be recorded fairly easily with surface
9600 Baud
9
electrodes placed on the limbs and/or the chest, see pages
8/1/N
below.
@author Lukas Kohler / BFH TI
@date 1 5 . 0 7 . 2 0 0 9
/
14
Josef Goette
22
Listing 3.2: Source Code Documentation with Doxygen
2
1 Intro
3.2 shows the used commands for
6–16
2009
STM32 Cortex-M3 Tutorial
3 Keil SDK