My Project
templateForC.h
Go to the documentation of this file.
1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /*****************************************************************************\
3  * Computer Algebra System SINGULAR
4 \*****************************************************************************/
5 /** @file templateForC.h
6  *
7  * This is our template for C headers.
8  *
9  * ABSTRACT: Some more description here.
10  *
11  * @author Oleksandr Motsak
12  *
13  *
14  **/
15 /*****************************************************************************/
16 
17 #ifndef TEMPLATE_FOR_C_H
18 #define TEMPLATE_FOR_C_H
19 
20 /** New type name for int. */
21 typedef int name;
22 
23 /** My enum. Or yours, if you want! */
24 enum myEnum
25  {
26  int EVal1, /**< Enum value 1 */
27  int EVal2 /**< Enum value 2 */
28  };
29 
30 /** F1.
31  *
32  * This is function 1.
33  *
34  * @return information about return value
35  * @sa strcpy
36  *
37  * The end!
38  */
39 int F1(
40  int a1, /**< [in] some int.
41  * aasas.
42  * bbbb.
43  */
44  int & r1 /**< [in,out] integer input and some resulting value */
45  );
46 
47 
48 
49 #endif
50 /* TEMPLATE_FOR_C_H */
51 
52 /* Vi-modeline: vim: filetype=c:syntax:shiftwidth=2:tabstop=8:textwidth=0:expandtab
53 */
myEnum
My enum.
Definition: templateForC.h:25
@ EVal1
Enum value 1.
Definition: templateForC.h:26
@ EVal2
Enum value 2.
Definition: templateForC.h:27
int name
New type name for int.
Definition: templateForC.h:21
int F1(int a1, int &r1)
F1.