Example Output
Example Mountain Bike Module
Generated Markdown for the MountainBike group in the bundled example
group mountainbike {#group__mountainbike}
Mountain bike module contains the MountainBike class. Mountain bikes are built for rough terrain.
Summary
| Members | Descriptions |
|---|---|
class transport::MountainBike | Mountain bike implementation of a Bicycle. |
class transport::MountainBike {#classtransport_1_1MountainBike}
class transport::MountainBike
: public transport::BicycleMountain bike implementation of a Bicycle.
MountainBike provides a bike for rough terrain. If you are looking for something optimized for road speed, use RacingBike instead.
Summary
| Members | Descriptions |
|---|---|
public bool SetSuspension(double stiffness) | Set suspension stiffness. |
public template<> inline bool ChangeBreak(BreakType breakType) | Change the brake type. |
Members
public bool SetSuspension(double stiffness) {#classtransport_1_1MountainBike_1a04caecd7e5ff7572b6ac1dc283510301}
Set suspension stiffness.
Returns true if the suspension was adjusted successfully, otherwise false.
public template<> inline bool ChangeBreak(BreakType breakType) {#classtransport_1_1MountainBike_1afd02513876a196e98acaacdc555aeb52}
Change the brake type.
Returns true if the brake was adjusted successfully, otherwise false.
