Example Output

Example Bicycle Module

Generated Markdown for the Bicycle group in the bundled example

group bicycle {#group__bicycle}

Bicycle module contains the bicycle class. Bicycles are a useful way of transporting oneself without too much effort.

Summary

MembersDescriptions
class transport::BicycleStandard bicycle class.

class transport::Bicycle {#classtransport_1_1Bicycle}

Standard bicycle class.

Bicycle implements a standard bicycle. Bicycles are a useful way of transporting oneself without too much effort, unless you go uphill or ride into the wind. If there are a lot of people on the road, you can use RingBell to ring your bell.

Summary

MembersDescriptions
public virtual void PedalHarder()PedalHarder makes you go faster.
public virtual void RingBell()Ring the bell on the bike.
public virtual ~Bicycle()Default destructor.

Members

public virtual void PedalHarder() {#classtransport_1_1Bicycle_1a7df6cce8f18012fb07bef5be9dadd8ef}

PedalHarder makes you go faster.

public virtual void RingBell() {#classtransport_1_1Bicycle_1a7d2be572f09c78b4d4ae38ef22f3e98b}

Ring the bell on the bike.

public virtual ~Bicycle() {#classtransport_1_1Bicycle_1a5f62d09b772a7705634bfb3551803c25}

Default destructor.