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