blob: 30dfdddd1ca3e6ac74fb7e0c8be6f44ec9e756ed (
plain)
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
42
43
44
45
46
47
|
/* Copyright (c) 2010 Joe Hacker <joe@example.com>
*
* This file is part of skeletonmm.
*
* skeletonmm is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 2.1 of the License,
* or (at your option) any later version.
*
* skeletonmm is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef SKELETONMM_H_INCLUDED
#define SKELETONMM_H_INCLUDED
/** @mainpage skeletonmm Reference Manual
*
* @section description Description
*
* The skeletonmm C++ binding provides a C++ interface on top of the skeleton
* C library.
*
* @section overview Overview
*
* [...]
*
* @section use Use
*
* To use skeletonmm in your C++ application, include the central header file
* <tt>\<skeletonmm.h\></tt>. The skeletonmm package ships a @c pkg-config
* file with the correct include path and link command-line for the compiler.
*/
#include <skeletonmmconfig.h>
#include <skeletonmm/skeleton.h>
/** @example example/example.cc
* A skeletonmm example program.
*/
#endif /* !SKELETONMM_H_INCLUDED */
|
