My Project
template.h
Go to the documentation of this file.
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 *
14 **/
15/*****************************************************************************/
16
17#ifndef TEMPLATE_H
18#define TEMPLATE_H
19
20// include basic definitions
21#include "singularxx_defs.h"
22
23BEGIN_NAMESPACE_SINGULARXX
24
25/** @class Template template.h <someRootDirectory/template.h>
26 *
27 * Brief description of class Template.
28 *
29 * Detailed description of class Template.
30 *
31 * @sa some other classes
32 */
33class Template: public TemplateBaseClass
34{
35public:
36 /// Name type of *this.
37 typedef Template Self;
38
39 /// My enum. Or yours, if you want!
40 enum MyEnum
41 {
42 int EVal1, ///< Enum value 1
43 int EVal2 ///< Enum value 2
44 };
45
46 /// Default constructor.
47 /// And now goes the detailed description....
49
50 /// Default destructor.
52
53
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
63 int &o ///< [in,out] integer input and resulting value
64 );
65
66 /// Example of Copy a string method.
67 ///
68 /// The strcpy2 function copies @a strSource, including
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.
72 /// The behavior of @a strcpy2 is undefined if the source
73 /// and destination strings overlap.
74 ///
75 /// @return @a strcpy2 returns the destination string.
76 /// No return value is reserved to indicate an error.
77 /// @sa someMethod(), wcscpy(), _mbscpy(), strncpy()
78 char* strcpy2(
79 char* strDestination, ///< [out] pointer to source null terminated.
80 ///< continue ...
81 const char* strSource ///< [in] pointer to destination memory.
82 );
83
84protected:
85 /// Short description of some flag till first dot. Everything after that will
86 /// be considered as a detaiiled description.
88};
89
90END_NAMESPACE_SINGULARXX
91
92#endif
93/* #ifndef TEMPLATE_H */
94
95// Vi-modeline: vim: filetype=c:syntax:shiftwidth=2:tabstop=8:textwidth=0:expandtab
Brief description of class Template.
Definition: template.h:34
int someMethod(int a, int &o)
Brief method description.
Definition: template.cc:25
~Template()
Default destructor.
MyEnum
My enum. Or yours, if you want!
Definition: template.h:41
@ EVal2
Enum value 2.
Definition: template.h:43
@ EVal1
Enum value 1.
Definition: template.h:42
bool m_bSomeFlag
Short description of some flag till first dot. Everything after that will be considered as a detaiile...
Definition: template.h:87
char * strcpy2(char *strDestination, const char *strSource)
Example of Copy a string method.
Template Self
Name type of *this.
Definition: template.h:37
Template()
Default constructor. And now goes the detailed description....