nutshell (C++ header)

An overly extended example of how to use breathe

class Nutshell

#include <nutshell.hpp>

A class.

With a little bit of a elaboration, should you feel it necessary. An inline formula \( f(x) = \alpha + \beta \)

A display style formula:

\[ \int_a^b dt \, f(x) = C \]

with some more comments…

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

Private Members

bool m_isCracked

Our cracked state.