CDPP / AMDA_Kernel

Blame view

src/Parameters/documentation.hh 1.07 KB
Edit Raw Normal View History
fbe3c2bb   Benjamin Renard   First commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
/**
 * documentation.hh
 *
 *  Created on: Feb 8, 2013
 *      Author: AKKA IS
 */

#ifndef DOCUMENTATION_HH_
#define DOCUMENTATION_HH_


 /*!
 * @mainpage AMDA-Kernel detailed conception
 * @section Introduction
 * This document describe the AMDA-Kernel conception.
 * Only the Parameters ,  Plugin , EvalFormule, Download and DD server Interface component  are describe.
 * - The main component are  Parameters:  AMDA::Parameters and  AMDA::Parameters::Parameter.
 * - The  EvalFormule component are detail by only one class:  AMDA::Parameters::ProcessStandard
 * - The  Download component are detail in namespace   AMDA::ParamOutputImpl::Download
 * - The  DD server Interface component are detail in namespace   AMDA::DDServerInterface
 *
 *
 * @author AKKA IS.
 */

/**
 * @brief Name space of AMDA.
 * @detail contain all sources of kernel AMDA
 */
namespace AMDA {
/**
 * @brief Kernel class  of AMDA Parameters module.
 * @detail this class define the data parameters flow
 */
namespace Parameters {

} /* namespace Parameters */
} /* namespace AMDA */


#endif /* DOCUMENTATION_HH_ */