[STYLE] Sampler: doxygen comments
[kernel/swap-modules.git] / sampler / swap_sampler_module.h
1 /**
2  * @file sampler/swap_sampler_module.h
3  * @author Alexander Aksenov <a.aksenov@samsung.com>
4  *
5  * @section LICENSE
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20  *
21  * @section COPYRIGHT
22  *
23  * Copyright (C) Samsung Electronics, 2013
24  *
25  * @section DESCRIPTION
26  *
27  * Sampling module interface declaration.
28  */
29
30
31 /* SWAP Sampler interface */
32
33 #ifndef __SWAP_SAMPLER_MODULE_H__
34 #define __SWAP_SAMPLER_MODULE_H__
35
36 /* Starts the SWAP Sampler */
37 int swap_sampler_start(unsigned int timer_quantum);
38
39 /* Stops the SWAP Sampler */
40 int swap_sampler_stop(void);
41
42 #endif /* __SWAP_SAMPLER_MODULE_H__ */