Public Interfaces¶

class Nutshell

Public Types

enum Tool

Our tool set.

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

Values:

enumerator kHammer = 0: 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()

Return: Whether or not the nut is cracked

Private Members

bool m_isCracked¶: Our cracked state.

file nutshell.h

An overly extended example of how to use breathe.

Enums

enum [anonymous]¶

Values:

enumerator YellowRoller¶

enumerator RedRoller¶

enumerator GreenRoller¶

enum [anonymous]¶

Values:

enumerator Chocolate¶

enumerator Mossy¶

enumerator CremeFraiche¶

group nuttygroup

The group for all nutjobs.

No nut can withstand us!

Enums

enum [anonymous]

Values:

enumerator YellowRoller

enumerator RedRoller

enumerator GreenRoller

group nuttygroup2

The group for all nutjobs.

More documentation for the second group.

Enums

enum [anonymous]

Values:

enumerator Chocolate

enumerator Mossy

enumerator CremeFraiche

dir /home/docs/checkouts/readthedocs.org/user_builds/roboy-sw-documentation-template/checkouts/lite/src