source: git/templates/templateForC.h @ 4e8ef90

spielwiese
Last change on this file since 4e8ef90 was 4c09bb, checked in by Oleksandr Motsak <motsak@…>, 14 years ago
Improved templateForC.h. Note: for input/output arguments use [in,out]!
  • Property mode set to 100644
File size: 1000 bytes
Line 
1/*****************************************************************************\
2 * Computer Algebra System SINGULAR   
3\*****************************************************************************/
4/** @file templateForC.h
5 *
6 * This is our template for C headers.
7 *
8 * ABSTRACT: Some more description here.
9 *
10 * @author Oleksandr Motsak
11 *
12 * @internal @version \$Id$
13 *
14 **/
15/*****************************************************************************/
16
17#ifndef TEMPLATE_FOR_C_H
18#define TEMPLATE_FOR_C_H
19
20/** New type name for int. */
21typedef int name;
22
23/** My enum. Or yours, if you want! */
24enum 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 */
39int 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 */
Note: See TracBrowser for help on using the repository browser.