root/components/WFMDemod/trunk/WFMDemod/documentation.txt @ 6185

Revision 6185, 1.5 KB (checked in by balister, 5 years ago)

Initial check for WFM demodulator.

Line 
1/****************************************************************************
2
3Copyright 2007 Virginia Polytechnic Institute and State University
4
5This file is part of the OSSIE WFMdemod.
6
7OSSIE WFMdemod is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2 of the License, or
10(at your option) any later version.
11
12OSSIE WFMdemod is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with OSSIE WFMdemod; if not, write to the Free Software
19Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20
21****************************************************************************/
22
23/*! \mainpage WFMdemod
24
25\section description Basic description
26Include a basic description of the WFMdemod component here
27
28\section properties Properties
29This section details the properties
30
31\subsection prop_property_name Property Name (DCE:xxxx-xxx-xxx-xxx-xxxx)
32
33\section interfaces Interfaces
34
35\subsection port_portName Port: "portName"
36There is a description for each port
37
38\section dependencies Software build dependencies
39  - Dependency 1
40  - Dependency 2
41
42\section algorithm Detailed Description of Algorithm
43
44\section status Status and history
45
46\section references References
47
48*/
Note: See TracBrowser for help on using the browser.