UsingDoxygenwithMatlab: classDocumentationExample Class Reference

• Main Page
• Related Pages
• Classes
• Files

• Class List
• Class Members

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes

classDocumentationExample Class Reference

Here we have a brief description of the class. More...

List of all members.

Public Types
enum	Events { FirstEvent, SecondEvent }
enum	classDocumentationExample { one = (1), two = (2), three }
	Description of the enumeration. More...
Public Member Functions
function	classDocumentationExample (in param1, in anotherParam)
	Class constructor.
function	exampleMethod1 (in obj)
	Brief description of the exampleMethod1 method.
function	exampleMethod2 (in obj)
	Brief description of the exampleMethod2 method.
function	examplePublicMethod2 (in param1)
	Brief description of the examplePublicMethod2 method.
function	exampleNonStaticPublicMethod3 (in param1)
	Brief description of the exampleNonStaticPublicMethod3 method.
virtual function	exampleAbstractMethod (in param1, in param2)
	Brief description of the exampleAbstractMethod method.
Static Public Member Functions
static function	exampleStaticMethod (in param1, in ignoredArg, in param2)
	Brief description of the exampleStaticMethod method.
static function	exampleStaticPublicMethod (in param1)
	Brief description of the exampleStaticPublicMethod method.
Public Attributes
Property	publicProperty
	Description of a public property.
Constant Property	constantProperty = {'1', '2', 'trois'}
	Description of a constant property.
Property	first_property
	Description of the first property of the class.
Property	second_property
	Description of the second property of the class.
Property	third_property
	Description of the third property of the class.
Protected Member Functions
function	exampleProtectedMethod (in param1)
	Brief description of the exampleProtectedMethod method.
Static Protected Member Functions
static function	exampleStaticProtectedMethod (in param1)
	Brief description of the exampleStaticProtectedMethod method.
Protected Attributes
Property	protectedProperty
	Description of a protected property.
Private Member Functions
function	examplePrivateMethod (in param1)
	Brief description of the examplePrivateMethod method.
Static Private Member Functions
static function	exampleStaticPrivateMethod (in param1, in param2)
	Brief description of the exampleStaticPrivateMethod method.
Private Attributes
Property	pivateProperty
	Description of a private property.

---

Detailed Description

Here we have a brief description of the class.

And here we can put some more detailed informations about the class.

---

Member Enumeration Documentation

enum classDocumentationExample

Description of the enumeration.

Enumerator:

one	Description of the first item.
two	Description of the second item.
three	Description of the third item.

enum Events

Enumerator:

FirstEvent	Description of first event.
SecondEvent	Description of second event.

---

Constructor & Destructor Documentation

function classDocumentationExample	(	in	param1,
		in	anotherParam
	)

Class constructor.

More detailed description of what the constructor does.

Parameters:

	param1	Description of first parameter
	anotherParam	Description of the second parametere

Returns:

instance of the classDocumentationExample class.

---

Member Function Documentation

virtual function exampleAbstractMethod	(	in	param1,
		in	param2
	)			[virtual]

Brief description of the exampleAbstractMethod method.

This method is abstract : only the signature of this function is declared.

Parameters:

	param1	Description of the first parameter
	param2	Description of the second parameter

Return values:

out

return value of this method

function exampleMethod1

(

in

obj

)

Brief description of the exampleMethod1 method.

Parameters:

obj

instance of the classDocumentationExample class.

function exampleMethod2

(

in

obj

)

Brief description of the exampleMethod2 method.

Parameters:

obj

instance of the classDocumentationExample class.

Return values:

ret

return value of this method

function exampleNonStaticPublicMethod3

(

in

param1

)

Brief description of the exampleNonStaticPublicMethod3 method.

This method is public and not static

Parameters:

param1

Description of the parameter

Return values:

out

return value of this method

function examplePrivateMethod

(

in

param1

)

[private]

Brief description of the examplePrivateMethod method.

This method is private

Parameters:

param1

Description of the parameter

Return values:

out

return value of this method

function exampleProtectedMethod

(

in

param1

)

[protected]

Brief description of the exampleProtectedMethod method.

This method is protected

Parameters:

param1

Description of the parameter

Return values:

out

return value of this method

function examplePublicMethod2

(

in

param1

)

Brief description of the examplePublicMethod2 method.

This method is public and not static

Parameters:

param1

Description of the parameter

Return values:

out

return value of this method

static function exampleStaticMethod	(	in	param1,
		in	ignoredArg,
		in	param2
	)			[static]

Brief description of the exampleStaticMethod method.

This method is static and public, with an inused (~) argument

Parameters:

	param1	Description of the parameter
	param2	Description of the parameter

Return values:

out

return value of this method

static function exampleStaticPrivateMethod	(	in	param1,
		in	param2
	)			[static, private]

Brief description of the exampleStaticPrivateMethod method.

This method is static and private

Parameters:

	param1	Description of the parameter
	param2	Description of the parameter

Return values:

out

return value of this method

static function exampleStaticProtectedMethod

(

in

param1

)

[static, protected]

Brief description of the exampleStaticProtectedMethod method.

This method is static and protected

Parameters:

param1

Description of the parameter

Return values:

out

return value of this method

static function exampleStaticPublicMethod

(

in

param1

)

[static]

Brief description of the exampleStaticPublicMethod method.

This method is static and public

Parameters:

param1

Description of the parameter

Return values:

out

return value of this method

---

Member Data Documentation

Constant Property constantProperty = {'1', '2', 'trois'}

Description of a constant property.

Property first_property

Description of the first property of the class.

Property pivateProperty [private]

Description of a private property.

Property protectedProperty [protected]

Description of a protected property.

Property publicProperty

Description of a public property.

Property second_property

Description of the second property of the class.

Property third_property

Description of the third property of the class.

---

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

• C:/DoxygenMatlab/classDocumentationExample.m

---

Generated on Fri Nov 12 2010 10:36:57 for UsingDoxygenwithMatlab by  1.7.1