Skip to content

Commit e4a0473

Browse files
authored
Update README.md
1 parent 7917f8c commit e4a0473

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,34 @@ constructors, methods, and fields.
3434

3535
#### Sample doxygen
3636

37-
```java
38-
/**
39-
* Effector is the interface for Casbin effectors.
40-
*/
41-
public interface Effector {
42-
/**
43-
* mergeEffects merges all matching results collected by the enforcer into a single decision.
37+
```c++
38+
namespace transport
39+
{
40+
/** Mountain bike implementation of a `Bicycle`.
4441
*
45-
* @param expr the expression of [policy_effect].
46-
* @param effects the effects of all matched rules.
47-
* @param results the matcher results of all matched rules.
48-
* @return the final effect.
42+
* MountainBike is an implementation of a Bicycle
43+
* providing a bike for cycling on rough terrain. Mountain bikes
44+
* are pretty cool because they have stuff like **Suspension** (and
45+
* you can even adjust it using SetSuspension). If you're looking
46+
* for a bike for use on the road, you might be better off using a
47+
* RacingBike though.
48+
*
49+
* @ingroup mountainbike
4950
*/
50-
boolean mergeEffects(String expr, Effect[] effects, float[] results);
51-
}
51+
class MountainBike : public Bicycle
52+
{
53+
public:
54+
/** Set suspension stiffness.
55+
* @stiffness the suspension stiffness.
56+
*
57+
* SetSuspension changes the stiffness of the suspension
58+
* on the bike. The method will return false if the stiffness
59+
* could not be adjusted.
60+
*
61+
* @return true if the suspension was adjusted successfully,
62+
* false otherwise.
63+
*/
64+
bool SetSuspension(double stiffness);
5265
```
5366
5467
#### Sample DITA Output

0 commit comments

Comments
 (0)