Class Template

[You may provide a short summary of the class here.]

Description

[The description of the class.]

Concepts

[Optional] [Include if there are any concepts that you want to describe in detail.]

API

Note

This example is taken from Breathe’s documentation to illustrate how this extenstion works.

class Nutshell

With a little bit of a elaboration, should you feel it necessary.

Public Types

enum Tool

Our tool set.

The various tools we can opt to use to crack this particular nut

Values:

enumerator kHammer

What? It does the job.

enumerator kNutCrackers

Boring.

enumerator kNinjaThrowingStars

Stealthy.

Public Functions

Nutshell()

Nutshell constructor.

~Nutshell()

Nutshell destructor.

void crack(Tool tool)

Crack that shell with specified tool

Parameters

tool – - the tool with which to crack the nut

bool isCracked()

Returns

Whether or not the nut is cracked

Examples

[Optional]

See Also

[Optional]