Base::ClassTemplate Class Reference

A test class. More...

#include <FileTemplate.h>

Public Types
enum	TEnum { TVal1, TVal2, TVal3 }
	An enum. More...

Public Member Functions
	ClassTemplate ()
	Construction. More...
int	testMe (int a, const char *s)
	a normal member taking two arguments and returning an integer value. More...
virtual void	testMeToo (char c1, char c2)=0
	A pure virtual member. More...
virtual	~ClassTemplate ()
	Destruction. More...

Public Attributes
enum Base::ClassTemplate::TEnum *	enumPtr
	enum pointer. More...
enum Base::ClassTemplate::TEnum	enumVar
	enum variable. More...

a group of methods
int	publicVar
	a public variable. More...
int(*	handler )(int a, int b)
	a function variable. More...
std::string	something
virtual void	one (void)=0
	I am method one. More...
virtual void	two (void)=0
	I am method two. More...
virtual void	three (void)=0
	I am method three. More...

Detailed Description

A test class.

A more elaborate class description. Detailed description with some formatting:

bla blablablablablablabl:

#include <Base/Console.h>
Base::Console().Log("Stage: %d",i);

nother blablablablablablablablablabl: Text before the list

• list item 1
  • sub item 1
    • sub sub item 1
    • sub sub item 2
    The dot above ends the sub sub item list. More text for the first sub item
  The dot above ends the first sub item. More text for the first list item
  • sub item 2
  • sub item 3
• list item 2

More text in the same paragraph.

More text in a new paragraph. Also with HTML tags:

• mouse events
  1. mouse move event
  2. mouse click event
     More info about the click event.
  3. mouse double click event
• keyboard events
  
  
• key down event
• key up event

More text here.

Author

YOUR NAME

Member Enumeration Documentation

TEnum

enum Base::ClassTemplate::TEnum

An enum.

More detailed enum description.

Enumerator
TVal1	enum value TVal1.
TVal2	enum value TVal2.
TVal3	enum value TVal3.

Constructor & Destructor Documentation

ClassTemplate()

ClassTemplate::ClassTemplate

(

)

Construction.

A constructor.

A more elaborate description of the constructor.

~ClassTemplate()

ClassTemplate::~ClassTemplate ( )

virtual

Destruction.

A destructor.

A more elaborate description of the destructor.

Member Function Documentation

one()

virtual void Base::ClassTemplate::one ( void  )

pure virtual

I am method one.

testMe()

int ClassTemplate::testMe	(	int	a,
		const char *	s
	)

a normal member taking two arguments and returning an integer value.

You can use a printf like interface like:

GetConsole().Warning("Some defects in %s, loading anyway\n",str);

Parameters

a	an integer argument.
s	a constant character pointer.

See also

ClassTemplate()

~ClassTemplate()

testMeToo()

publicVar()

Returns

The test results

testMeToo()

virtual void Base::ClassTemplate::testMeToo ( char  c1, char  c2  )

pure virtual

A pure virtual member.

See also

testMe()

Parameters

c1	the first argument.
c2	the second argument.

three()

virtual void Base::ClassTemplate::three ( void  )

pure virtual

I am method three.

two()

virtual void Base::ClassTemplate::two ( void  )

pure virtual

I am method two.

Member Data Documentation

enumPtr

enum Base::ClassTemplate::TEnum * Base::ClassTemplate::enumPtr

enum pointer.

Details.

enumVar

enum Base::ClassTemplate::TEnum Base::ClassTemplate::enumVar

enum variable.

Details.

handler

int(* Base::ClassTemplate::handler) (int a, int b)

a function variable.

Details.

publicVar

int Base::ClassTemplate::publicVar

a public variable.

Details.

something

std::string Base::ClassTemplate::something

---

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

• src/Base/FileTemplate.h
• src/Base/FileTemplate.cpp