Doxygen C example  0.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator
doxygen_c.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (C) 2012 by Matteo Franchin *
3  * *
4  * This file is part of Box. *
5  * *
6  * Box is free software: you can redistribute it and/or modify it *
7  * under the terms of the GNU Lesser General Public License as published *
8  * by the Free Software Foundation, either version 3 of the License, or *
9  * (at your option) any later version. *
10  * *
11  * Box is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14  * GNU Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with Box. If not, see <http://www.gnu.org/licenses/>. *
18  ****************************************************************************/
19 
33 #ifndef _BOX_PROTOTYPES_DOXYGEN_H
34 # define _BOX_PROTOTYPES_DOXYGEN_H
35 
36 # include <systemheader1.h>
37 # include <systemheader2.h>
38 
39 # include <box/header1.h>
40 # include <box/header2.h>
41 
42 # include "local_header1.h"
43 # include "local_header2.h"
44 
50 typedef enum BoxEnum_enum {
54 } BoxEnum;
55 
61 typedef struct BoxStruct_struct {
62  int a;
63  int b;
64  double c;
65 } BoxStruct;
66 
100 BOXEXPORT BoxStruct *
101 Box_The_Function_Name(BoxParamType1 param1, BoxParamType2 param2 /*, ...*/);
102 
114 BOXEXPORT void *
116 
124 BOXEXPORT void
125 Box_The_Last_One(void);
126 
127 #endif /* _BOX_PROTOTYPES_DOXYGEN_H */