ExampleClass Class Reference

One-line class description. More...

#include <Template.h>

List of all members.

Public Member Functions
void	draw (Window win)
	ExampleClass (ExampleClass &ref)
	ExampleClass ()
ExampleClass &	operator= (ExampleClass &ref)
	~ExampleClass ()
Protected Attributes
int	xmax
int	xmin

---

Detailed Description

One-line class description.

Long description. There is no need to repeat the class name in the one-line description. The long description should describe the abstraction and point the user to the main member functions. An example could be inserted when this is informative and not redundant with the file description. Templates should document which member functions are required for their type argument. The availability of non availabilty of a copy constructor/copy operator can be specified when appropriate. See the doc++ documentation for available LaTeX constructs.

Definition at line 162 of file Template.h.

---

Constructor & Destructor Documentation

ExampleClass::~ExampleClass

(

)

Virtual Destructor.

ExampleClass::ExampleClass

(

)

Null Constructor.

ExampleClass::ExampleClass

(

ExampleClass &

ref

)

Copy Constructor.

---

Member Function Documentation

void ExampleClass::draw

(

Window

win

)

Example of member function.

The first sentence of the member function description must be a short single line description. The rest can be more verbose. Excerpts of C or C++ text should be surrounded by dieze characters (as in win#). The doc++ #

Parameters:

		construct should be used when there is a need for additional details about the arguments. In that case all the arguments must be documented with a #
		directive.
	win	drawing window. This window must be created with CreateWindow# and must be visible when function draw# is called.

ExampleClass& ExampleClass::operator=

(

ExampleClass &

ref

)

Copy operator.

---

Member Data Documentation

int ExampleClass::xmax [protected]

Maximal x-coordinate.

Definition at line 189 of file Template.h.

int ExampleClass::xmin [protected]

Minimal x-coordinate.

Definition at line 187 of file Template.h.

---

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

• Template.h