ExampleClass Class Reference

Here is a brief description of the example class. More...

#include <example.h>

Public Member Functions
	ExampleClass ()
	Create an ExampleClass. More...
	ExampleClass (int a, float b)
	Create an ExampleClass with lot's of intial values. More...
	~ExampleClass ()
	ExampleClass destructor description. More...
void	DoSomething ()
	This method does something. More...
void	DoNothing ()
	This is a method that does so much that I must write an epic novel just to describe how much it truly does. More...
void *	VeryUsefulMethod (bool level)
	Brief description of a useful method. More...
void *	AnotherMethod (bool level)
	Brief description of a useful method. More...

Private Attributes
const char *	fQuestion
	The question. More...
int	fAnswer
	The answer. More...

Detailed Description

Here is a brief description of the example class.

This is a more in-depth description of the class. This class is meant as an example. It is not useful by itself, rather its usefulness is only a function of how much it helps the reader. It is in a sense defined by the person who reads it and otherwise does not exist in any real form.

Note

This is a note.

Constructor & Destructor Documentation

ExampleClass::ExampleClass

(

)

Create an ExampleClass.

ExampleClass::ExampleClass	(	int	a,
		float	b
	)

Create an ExampleClass with lot's of intial values.

Parameters

a	This is a description of parameter a.
b	This is a description of parameter b.

ExampleClass::~ExampleClass

(

)

ExampleClass destructor description.

Parameters

a	This is a description of parameter a.
b	This is a description of parameter b. The distance between \((x_1,y_1)\) and \((x_2,y_2)\) is \(\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\).

Member Function Documentation

void* ExampleClass::AnotherMethod

(

bool

level

)

Brief description of a useful method.

Parameters

level

An integer setting how useful to be.

Returns

Description of the output.

• Item 1

  More text for this item.

• Item 2
  • nested list item.
  • another nested item.
• Item 3

Markdown Example

Here is a link.

void ExampleClass::DoNothing

(

)

This is a method that does so much that I must write an epic novel just to describe how much it truly does.

void ExampleClass::DoSomething

(

)

This method does something.

void* ExampleClass::VeryUsefulMethod

(

bool

level

)

Brief description of a useful method.

Parameters

level

An integer setting how useful to be.

Returns

Description of the output.

This method does unbelievably useful things. And returns exceptionally useful results. Use it everyday with good health.

\[ |I_2|=\left| \int_{0}^T \psi(t) \left\{ u(a,t)- \int_{\gamma(t)}^a \frac{d\theta}{k(\theta,t)} \int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi \right\} dt \right| \]

Member Data Documentation

int ExampleClass::fAnswer

private

The answer.

const char* ExampleClass::fQuestion

private

The question.

---

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

• example.h