From 7405f45cdfe1813d03ba7592560c15b70480b1a5 Mon Sep 17 00:00:00 2001
From: mgreiff <marcusgreiff.93@hotmail.com>
Date: Thu, 18 Jan 2018 12:45:48 +0100
Subject: [PATCH] Update docs
---
docs/build/lib/functions.md | 26 +++++++++++++-------------
docs/build/lib/io_devices.md | 8 ++++----
src/BeagleBone/Debug.jl | 2 +-
src/BeagleBone/GPIO.jl | 2 +-
src/BeagleBone/PWM.jl | 2 +-
src/BeagleBone/SysLED.jl | 2 +-
6 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/docs/build/lib/functions.md b/docs/build/lib/functions.md
index 873f486..733b6bb 100644
--- a/docs/build/lib/functions.md
+++ b/docs/build/lib/functions.md
@@ -51,14 +51,14 @@ Reads the current brightness value from the LED 'SysLED'.
-l = read(pwm::PWM, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO.
+l = read(gpio::GPIO, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO.
<a id='Base.read' href='#Base.read'>#</a>
**`Base.read`** — *Function*.
-l = read(gpio::GPIO, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO.
+l = read(pwm::PWM, operation::Int32, debug::Bool=false) Reads the current value from an operation on a GPIO.
<a id='LabConnections.BeagleBone.assert_pwm_write-Tuple{Int32,String}' href='#LabConnections.BeagleBone.assert_pwm_write-Tuple{Int32,String}'>#</a>
**`LabConnections.BeagleBone.assert_pwm_write`** — *Method*.
@@ -152,18 +152,18 @@ message = printdev() Prints all the active devices and writes out specifics of a
-teardown(gpio::GPIO, debug::Bool=false) Closes all open streams on the GPIO, and unexports it from the file system.
+```
+teardown!(pwd::PWM)
+```
+
+Closes all open streams on the PWM, and unexports it from the file system
<a id='LabConnections.BeagleBone.teardown' href='#LabConnections.BeagleBone.teardown'>#</a>
**`LabConnections.BeagleBone.teardown`** — *Function*.
-```
-teardown(led::SysLED, debug::Bool=false)
-```
-
-Closes all open filestreams for the SysLED 'led'.
+teardown(gpio::GPIO, debug::Bool=false) Closes all open streams on the GPIO, and unexports it from the file system.
<a id='LabConnections.BeagleBone.teardown' href='#LabConnections.BeagleBone.teardown'>#</a>
**`LabConnections.BeagleBone.teardown`** — *Function*.
@@ -171,31 +171,31 @@ Closes all open filestreams for the SysLED 'led'.
```
-teardown!(pwd::PWM)
+teardown(led::SysLED, debug::Bool=false)
```
-Closes all open streams on the PWM, and unexports it from the file system
+Closes all open filestreams for the SysLED 'led'.
<a id='LabConnections.BeagleBone.to_string' href='#LabConnections.BeagleBone.to_string'>#</a>
**`LabConnections.BeagleBone.to_string`** — *Function*.
-to_string(gpio::GPIO, debug::Bool=false) Generates a string representation of the GPIO device.
+to_string(pwm::PWM,, debug::Bool=false) Generates a string representation of the GPIO device.
<a id='LabConnections.BeagleBone.to_string' href='#LabConnections.BeagleBone.to_string'>#</a>
**`LabConnections.BeagleBone.to_string`** — *Function*.
-to_string(led::SysLED, debug::Bool=false) Generates a string representation of the GPIO device.
+to_string(gpio::GPIO, debug::Bool=false) Generates a string representation of the GPIO device.
<a id='LabConnections.BeagleBone.to_string' href='#LabConnections.BeagleBone.to_string'>#</a>
**`LabConnections.BeagleBone.to_string`** — *Function*.
-to_string(pwm::PWM,, debug::Bool=false) Generates a string representation of the GPIO device.
+to_string(led::SysLED, debug::Bool=false) Generates a string representation of the GPIO device.
<a id='LabConnections.BeagleBone.write!' href='#LabConnections.BeagleBone.write!'>#</a>
**`LabConnections.BeagleBone.write!`** — *Function*.
diff --git a/docs/build/lib/io_devices.md b/docs/build/lib/io_devices.md
index e43120c..8ca539c 100644
--- a/docs/build/lib/io_devices.md
+++ b/docs/build/lib/io_devices.md
@@ -15,7 +15,7 @@
```
-Debug()
+Debug(i::Int32)
```
Type for debugging and precompile
@@ -26,7 +26,7 @@ Type for debugging and precompile
```
-GPIO()
+GPIO(i::Int32)
```
Lowest form of communication with the GPIO pins. The available pins are listed in the "channel" parameter, and appear as directories in /sys/class/gpio after being exported. For instance, to setup a GPIO on "gpio112", configure it as an output pin and set it to high, the following code would be used.
@@ -56,7 +56,7 @@ Define abstract type for pins/LEDS on the BeagleBone
```
-PWM()
+PWM(i::Int32)
```
This device allows for low level PWM control of selected pins. The valid pins dictionary pwm_pins relates to memory adresses in of the AM3359 chip, see p.182 in www.ti.com/product/AM3359/technicaldocuments.
@@ -67,7 +67,7 @@ This device allows for low level PWM control of selected pins. The valid pins di
```
-SysLED
+SysLED(i::Int32)
```
Type representing the system LEDs on the BeagleBone. The LEDs are indexed by i ∈ [1,2,3,4].
diff --git a/src/BeagleBone/Debug.jl b/src/BeagleBone/Debug.jl
index 9c3b033..181a23b 100644
--- a/src/BeagleBone/Debug.jl
+++ b/src/BeagleBone/Debug.jl
@@ -1,5 +1,5 @@
"""
- Debug()
+ Debug(i::Int32)
Type for debugging and precompile
"""
type Debug <: IO_Object
diff --git a/src/BeagleBone/GPIO.jl b/src/BeagleBone/GPIO.jl
index 52e36ab..09a872a 100644
--- a/src/BeagleBone/GPIO.jl
+++ b/src/BeagleBone/GPIO.jl
@@ -1,5 +1,5 @@
"""
- GPIO()
+ GPIO(i::Int32)
Lowest form of communication with the GPIO pins. The available pins are
listed in the "channel" parameter, and appear as directories in /sys/class/gpio
after being exported. For instance, to setup a GPIO on "gpio112", configure it as an output pin and set
diff --git a/src/BeagleBone/PWM.jl b/src/BeagleBone/PWM.jl
index 395fcb0..a6b4d20 100644
--- a/src/BeagleBone/PWM.jl
+++ b/src/BeagleBone/PWM.jl
@@ -1,5 +1,5 @@
"""
- PWM()
+ PWM(i::Int32)
This device allows for low level PWM control of selected pins. The valid pins
dictionary pwm_pins relates to memory adresses in of the AM3359 chip, see p.182
in www.ti.com/product/AM3359/technicaldocuments.
diff --git a/src/BeagleBone/SysLED.jl b/src/BeagleBone/SysLED.jl
index f18c850..42ce55a 100644
--- a/src/BeagleBone/SysLED.jl
+++ b/src/BeagleBone/SysLED.jl
@@ -1,5 +1,5 @@
"""
- SysLED
+ SysLED(i::Int32)
Type representing the system LEDs on the BeagleBone. The LEDs are indexed by
i ∈ [1,2,3,4].
"""
--
GitLab