example::Demo Class Reference

A demo class, it's really just for demonstration. More...

Inheritance diagram for example::Demo:

List of all members.

Public Member Functions
	__init__ ()
	foo (bar)
Protected Member Functions
	spam (amount)

---

Detailed Description

A demo class, it's really just for demonstration.

The detailed description of the class would appear right here. However, as this class is utterly useless when talking about its functionality it actually has no detailed description which is sort of a pity, since a couple of lines of documentation would make it look like a real documentation. But as this is just an example of how the doxygen output might look like a one-liner has to be enough. Insert your documentation here as appropriate. You get the idea now, don't you? If not, I can't help it but I certainly won't type in a lot of nonsense just to make it look real. No, definitely not.

---

Member Function Documentation

example::Demo::__init__ (   )

The constructor. Reimplemented in example::AnotherDemo.

example::Demo::foo (  bar   )

The infamous foo method. There's no detailed description necessary for the foo() function as everybody know what it does. Parameters: bar  The bar argument is compulsory, never leave it out. Returns: The bar input after processing by the foo() function.

example::Demo::spam (  amount   )  [protected]

Return an amount of spam. Parameters: amount  (int) The amount of spam. Returns: An amount of spam.

---

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

• example.py

---