Brief description of class Template. More...

#include <someRootDirectory/template.h>

Public Types
enum	MyEnum { EVal1 , EVal2 }
	My enum. Or yours, if you want! More...

typedef Template	Self
	Name type of *this. More...

Public Member Functions
	Template ()
	Default constructor. And now goes the detailed description.... More...

	~Template ()
	Default destructor. More...

int	someMethod (int a, int &o)
	Brief method description. More...

char *	strcpy2 (char strDestination, const char strSource)
	Example of Copy a string method. More...

Protected Attributes
bool	m_bSomeFlag
	Short description of some flag till first dot. Everything after that will be considered as a detaiiled description. More...

Detailed Description

Brief description of class Template.

Detailed description of class Template.

See also: some other classes

Definition at line 28 of file template.h.

Member Typedef Documentation

◆ Self

typedef Template Template::Self

Name type of *this.

Definition at line 32 of file template.h.

Member Enumeration Documentation

◆ MyEnum

enum Template::MyEnum

My enum. Or yours, if you want!

Enumerator
EVal1	Enum value 1.
EVal2	Enum value 2.

Definition at line 35 of file template.h.

  {
    int EVal1, ///< Enum value 1
    int EVal2  ///< Enum value 2
  };

Constructor & Destructor Documentation

◆ Template()

Template::Template ( )

Default constructor. And now goes the detailed description....

◆ ~Template()

Template::~Template ( )

Default destructor.

Member Function Documentation

◆ someMethod()

USING_NAMESPACE_SINGULARXX int Template::someMethod	(	int	a,
		int &	o
	)

Brief method description.

We use Algorithm ABC from Book...

Detailed method description.

Returns: information about return value

See also: strcpy2

Parameters

[in]	a	some int
[in,out]	o	integer input and resulting value

Definition at line 25 of file template.cc.

{
  int t = o;
 
  // return something
  o = a;
  return t;
};

◆ strcpy2()

char * Template::strcpy2	(	char *	strDestination,
		const char *	strSource
	)

Example of Copy a string method.

The strcpy2 function copies strSource, including the terminating null character, to the location specified by strDestination. No overflow checking is performed when strings are copied or appended. The behavior of strcpy2 is undefined if the source and destination strings overlap.

Returns: strcpy2 returns the destination string. No return value is reserved to indicate an error.

See also: someMethod(), wcscpy(), _mbscpy(), strncpy()

Parameters

[out]	strDestination	pointer to source null terminated. continue ...
[in]	strSource	pointer to destination memory.

Field Documentation

◆ m_bSomeFlag

bool Template::m_bSomeFlag

protected

Short description of some flag till first dot. Everything after that will be considered as a detaiiled description.

Definition at line 82 of file template.h.

The documentation for this class was generated from the following files:

templates/template.h
templates/template.cc

Public Types

Public Member Functions

Protected Attributes