Base::ClassTemplate Class Reference

A test class. More...

#include <FileTemplate.h>

List of all members.

Public Types
enum	TEnum { TVal1, TVal2, TVal3 }
	An enum. More...
Public Member Functions
	ClassTemplate ()
	Construction.
int	testMe (int a, const char *s)
	a normal member taking two arguments and returning an integer value.
virtual void	testMeToo (char c1, char c2)=0
	A pure virtual member.
virtual	~ClassTemplate ()
	Destruction.
a group of methods
virtual void	one (void)=0
	I am method one.
virtual void	three (void)=0
	I am method three.
virtual void	two (void)=0
	I am method two.
Public Attributes
enum Base::ClassTemplate::TEnum *	enumPtr
	An enum.
enum Base::ClassTemplate::TEnum	enumVar
	enum variable.
int(*	handler )(int a, int b)
	a function variable.
int	publicVar
	a public variable.
std::string	something

---

Detailed Description

A test class.

A more elaborate class description. Detaild description with some formating:

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
  1. key down event
  2. key up event

More text here.

Author:

YOUR NAME

Definition at line 82 of file FileTemplate.h.

---

Member Enumeration Documentation

enum Base::ClassTemplate::TEnum

An enum.

More detailed enum description.

Enumerator:

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

Definition at line 97 of file FileTemplate.h.

---

Constructor & Destructor Documentation

ClassTemplate::ClassTemplate

(

)

Construction.

A constructor.

A more elaborate description of the constructor.

Definition at line 43 of file FileTemplate.cpp.

ClassTemplate::~ClassTemplate

(

)

[virtual]

Destruction.

A destructor.

A more elaborate description of the destructor.

Definition at line 51 of file FileTemplate.cpp.

---

Member Function Documentation

virtual void Base::ClassTemplate::one

(

void

)

[pure virtual]

I am method one.

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

Definition at line 74 of file FileTemplate.cpp.

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.

virtual void Base::ClassTemplate::three

(

void

)

[pure virtual]

I am method three.

virtual void Base::ClassTemplate::two

(

void

)

[pure virtual]

I am method two.

---

Member Data Documentation

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

An enum.

More detailed enum description. enum pointer. Details.

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

enum variable.

Details.

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

a function variable.

Details.

int Base::ClassTemplate::publicVar

a public variable.

Details.

Definition at line 128 of file FileTemplate.h.

std::string Base::ClassTemplate::something

Definition at line 136 of file FileTemplate.h.

---

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

• FileTemplate.h
• FileTemplate.cpp