source: git/templates/template.h @ 4f6451

spielwiese
Last change on this file since 4f6451 was 4f6451, checked in by Oleksandr Motsak <motsak@…>, 13 years ago
More or less finished templates!
  • Property mode set to 100644
File size: 2.6 KB
Line 
1//*****************************************************************************
2// Computer Algebra System SINGULAR   
3// Copyright: See COPYING file that comes with this distribution
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 SINGULAR_TEMPLATE_CLASS_h_
19#define SINGULAR_TEMPLATE_CLASS_h_
20
21// include basic definitions
22#include "singularxx_defs.h"
23
24BEGIN_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 */
34class TEMPLATE: public TEMPLATE_BASE_CLASS
35{
36public:
37  /// Name type of *this. 
38  typedef TEMPLATE self;
39
40  /// My enum. Or yours, if you want!
41  enum My
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  /// And now goes its detailed description....
53  ~TEMPLATE();
54 
55
56  /** Brief method description.
57   *
58   * Detailed method description.
59   *
60   * @param [in] a some int
61   * @param [out] o integer result
62   * @return information about return value
63   * @sa strcpy2
64   */
65  int Method( int a, int &o );
66
67  /// Example of Copy a string method.
68  ///
69  /// The strcpy 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 strcpy is undefined if the source
74  /// and destination strings overlap.
75  ///
76  /// @return @a strcpy returns the destination string.
77  /// No return value is reserved to indicate an error.
78  /// @sa Method(), wcscpy(), _mbscpy(), strncpy()
79  char* strcpy2(
80            char* strDestination,  ///< [out] pointer to source null terminated
81                                   ///< string ...
82                                   ///< continue ...
83            const char* strSource  ///< [in] pointer to destination memory ....
84                                   ///< continue ...
85               );
86
87
88protected:
89  /// Short description of some flag. Long description: use this format to document a variable or
90  /// method
91  bool m_bSomeFlag;
92};
93
94END_NAMESPACE_SINGULARXX
95
96#endif
97/* #ifndef SINGULAR_TEMPLATE_CLASS_h_ */
Note: See TracBrowser for help on using the repository browser.