Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

fix markdown docs

  • Loading branch information...
commit e52b7192940205c25301dc6d2994e57f8e453cd4 1 parent 6894afb
@XixeBombilla XixeBombilla authored
Showing with 50 additions and 24 deletions.
  1. +48 −24 docs/commands.md
  2. +2 −0  docs/events.md
View
72 docs/commands.md
@@ -1,58 +1,82 @@
# Commands
-## land() → nil
+## land()
-Public: Initiates a landing sequence.
+Initiates a landing sequence.
-Returns nil
+##### Returns
-## takeoff() → nil
+`nil`
-Public: Initiates take off sequence.
+## takeoff()
-Returns nil
+Initiates take off sequence.
-## hover() → nil
+##### Returns
-Public: Makes the crazyflie hover in a position.
+`nil`
-Returns nil
+## hover()
-## setPitch(deg) → nil
+Makes the crazyflie hover in a position.
-Public: Orders crazyflie to go forward or backward by the amount specified by deg.
+##### Returns
+
+`nil`
+
+## setPitch(deg)
+
+Orders crazyflie to go forward or backward by the amount specified by deg.
+
+##### Params
- **deg** - The degrees which to return data
-Returns nil
+##### Returns
+
+`nil`
+
+## setYaw(deg)
-## setYaw(deg) → nil
+Orders crazyflie to turn left or right by the amount specified by deg.
-Public: Orders crazyflie to turn left or right by the amount specified by deg.
+##### Params
- **deg** - The degrees which to return data
-Returns nil
+##### Returns
-## setThrust(accelerate) → nil
+`nil`
-Public: Orders crazyflie to accelerate.
+## setThrust(accelerate)
+
+Orders crazyflie to accelerate.
+
+##### Params
- **accelerate** - The acceleration which to return data
-Returns nil
+##### Returns
+
+`nil`
-## shutdown() → nil
+## shutdown()
-Public: Shutdown the device.
+Shutdown the device.
-Returns nil
+##### Returns
-## setParam(param, value) → (param, value)
+`nil`
-Public: Set the parameters for crazyflie.
+## setParam(param, value)
+
+Set the parameters for crazyflie.
+
+##### Params
- **param** - params
- **value** - params
-Returns (param, value)
+##### Returns
+
+`(param, value)`
View
2  docs/events.md
@@ -8,6 +8,8 @@ Sent when the device has been stopped.
Set the parameters for crazyflie.
+##### Params
+
- **param** - The params which to return data
- **value** - The value which to return data
Please sign in to comment.
Something went wrong with that request. Please try again.