1 | // -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
---|
2 | /*****************************************************************************\ |
---|
3 | * Computer Algebra System SINGULAR |
---|
4 | \*****************************************************************************/ |
---|
5 | /** @file template.h |
---|
6 | * |
---|
7 | * This file defines the class Template. |
---|
8 | * |
---|
9 | * ABSTRACT: We need this for something... |
---|
10 | * |
---|
11 | * @author Oleksandr Motsak |
---|
12 | * |
---|
13 | * @internal @version \$Id$ |
---|
14 | * |
---|
15 | **/ |
---|
16 | /*****************************************************************************/ |
---|
17 | |
---|
18 | #ifndef TEMPLATE_H |
---|
19 | #define TEMPLATE_H |
---|
20 | |
---|
21 | // include basic definitions |
---|
22 | #include <singularxx_defs.h> |
---|
23 | |
---|
24 | BEGIN_NAMESPACE_SINGULARXX |
---|
25 | |
---|
26 | /** @class Template template.h <someRootDirectory/template.h> |
---|
27 | * |
---|
28 | * Brief description of class Template. |
---|
29 | * |
---|
30 | * Detailed description of class Template. |
---|
31 | * |
---|
32 | * @sa some other classes |
---|
33 | */ |
---|
34 | class Template: public TemplateBaseClass |
---|
35 | { |
---|
36 | public: |
---|
37 | /// Name type of *this. |
---|
38 | typedef Template Self; |
---|
39 | |
---|
40 | /// My enum. Or yours, if you want! |
---|
41 | enum MyEnum |
---|
42 | { |
---|
43 | int EVal1, ///< Enum value 1 |
---|
44 | int EVal2 ///< Enum value 2 |
---|
45 | }; |
---|
46 | |
---|
47 | /// Default constructor. |
---|
48 | /// And now goes the detailed description.... |
---|
49 | Template(); |
---|
50 | |
---|
51 | /// Default destructor. |
---|
52 | ~Template(); |
---|
53 | |
---|
54 | |
---|
55 | /// Brief method description. |
---|
56 | /// |
---|
57 | /// Detailed method description. |
---|
58 | /// |
---|
59 | /// @return information about return value |
---|
60 | /// @sa strcpy2 |
---|
61 | /// |
---|
62 | int someMethod( |
---|
63 | int a, ///< [in] some int |
---|
64 | int &o ///< [in,out] integer input and resulting value |
---|
65 | ); |
---|
66 | |
---|
67 | /// Example of Copy a string method. |
---|
68 | /// |
---|
69 | /// The strcpy2 function copies @a strSource, including |
---|
70 | /// the terminating null character, to the location |
---|
71 | /// specified by @a strDestination. No overflow checking |
---|
72 | /// is performed when strings are copied or appended. |
---|
73 | /// The behavior of @a strcpy2 is undefined if the source |
---|
74 | /// and destination strings overlap. |
---|
75 | /// |
---|
76 | /// @return @a strcpy2 returns the destination string. |
---|
77 | /// No return value is reserved to indicate an error. |
---|
78 | /// @sa someMethod(), wcscpy(), _mbscpy(), strncpy() |
---|
79 | char* strcpy2( |
---|
80 | char* strDestination, ///< [out] pointer to source null terminated. |
---|
81 | ///< continue ... |
---|
82 | const char* strSource ///< [in] pointer to destination memory. |
---|
83 | ); |
---|
84 | |
---|
85 | protected: |
---|
86 | /// Short description of some flag till first dot. Everything after that will |
---|
87 | /// be considered as a detaiiled description. |
---|
88 | bool m_bSomeFlag; |
---|
89 | }; |
---|
90 | |
---|
91 | END_NAMESPACE_SINGULARXX |
---|
92 | |
---|
93 | #endif |
---|
94 | /* #ifndef TEMPLATE_H */ |
---|
95 | |
---|
96 | // Vi-modeline: vim: filetype=c:syntax:shiftwidth=2:tabstop=8:textwidth=0:expandtab |
---|