source: git/templates/templateForC.h @ 6ce030f

spielwiese
Last change on this file since 6ce030f was 6ce030f, checked in by Oleksandr Motsak <motsak@…>, 11 years ago
removal of the $Id$ svn tag from everywhere NOTE: the git SHA1 may be used instead (only on special places) NOTE: the libraries Singular/LIB/*.lib still contain the marker due to our current use of svn
  • Property mode set to 100644
File size: 1.1 KB
Line 
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. */
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 */
51
52/* Vi-modeline: vim: filetype=c:syntax:shiftwidth=2:tabstop=8:textwidth=0:expandtab
53*/
Note: See TracBrowser for help on using the repository browser.