Example Output

Example Racing Bike Module

Generated Markdown for the RacingBike group in the bundled example

group racingbike {#group__racingbike}

Racing bike module contains the RacingBike class. Racing bikes are optimized for speed on paved roads.

Summary

MembersDescriptions
class transport::RacingBikeRacing bike class.

class transport::RacingBike {#classtransport_1_1RacingBike}

class transport::RacingBike
  : public transport::Bicycle

Racing bike class.

RacingBike is a special kind of bike which can go much faster on the road with less effort. It does not make much sense to call RingBell on a racing bike because they typically do not have bells.

Summary

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

Members

public virtual void PedalHarder() {#classtransport_1_1RacingBike_1ab557c5727daa07a5001782d5dcd46c5b}

PedalHarder makes you go faster.

public virtual void RingBell() {#classtransport_1_1RacingBike_1ad32dc3b06a453fba3e20329842bb318b}

Ring the bell on the bike.