Merge branch 'release/v0.2.0'

WootingKb · Sep 9, 2019 · 1ca2e6a · 1ca2e6a
2 parents b0a944c + ae02222
commit 1ca2e6a
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 3 deletions.
diff --git a/SDK_USAGE.md b/SDK_USAGE.md
@@ -32,6 +32,7 @@ Initialises the Analog SDK, this needs to be successfully called before any othe
 * `Ok`: Meaning the SDK initialised successfully (currently also means that there is at least one plugin initialised with at least one device connected)
 * `NoDevices`: Meaning the SDK initialised successfully, but no devices are connected
 * `NoPlugins`: Meaning that either no plugins were found or some were found but none were successfully initialised
+* `FunctionNotFound`: Indicates that the SDK was not found, either it is not installed or it hasn't been added to the PATH
 
 ## Is Initialised
 ```c

diff --git a/includes-cpp/wooting-analog-wrapper.h b/includes-cpp/wooting-analog-wrapper.h
@@ -40,7 +40,7 @@ int wooting_analog_get_connected_devices_info(WootingAnalog_DeviceInfo **buffer,
 /// * `Ok`: Meaning the SDK initialised successfully (currently also means that there is at least one plugin initialised with at least one device connected)
 /// * `NoDevices`: Meaning the SDK initialised successfully, but no devices are connected
 /// * `NoPlugins`: Meaning that either no plugins were found or some were found but none were successfully initialised
-///
+/// * `FunctionNotFound`: Indicates that the SDK was not found, either it is not installed or it hasn't been added to the PATH
 WootingAnalogResult wooting_analog_initialise();
 
 /// Returns a bool indicating if the Analog SDK has been initialised

diff --git a/includes/wooting-analog-wrapper.h b/includes/wooting-analog-wrapper.h
@@ -38,7 +38,7 @@ int wooting_analog_get_connected_devices_info(WootingAnalog_DeviceInfo **buffer,
 /// * `Ok`: Meaning the SDK initialised successfully (currently also means that there is at least one plugin initialised with at least one device connected)
 /// * `NoDevices`: Meaning the SDK initialised successfully, but no devices are connected
 /// * `NoPlugins`: Meaning that either no plugins were found or some were found but none were successfully initialised
-///
+/// * `FunctionNotFound`: Indicates that the SDK was not found, either it is not installed or it hasn't been added to the PATH
 WootingAnalogResult wooting_analog_initialise(void);
 
 /// Returns a bool indicating if the Analog SDK has been initialised

diff --git a/wooting-analog-wrapper/src/lib.rs b/wooting-analog-wrapper/src/lib.rs
@@ -88,7 +88,7 @@ dynamic_extern! {
         /// * `Ok`: Meaning the SDK initialised successfully (currently also means that there is at least one plugin initialised with at least one device connected)
         /// * `NoDevices`: Meaning the SDK initialised successfully, but no devices are connected
         /// * `NoPlugins`: Meaning that either no plugins were found or some were found but none were successfully initialised
-        ///
+        /// * `FunctionNotFound`: Indicates that the SDK was not found, either it is not installed or it hasn't been added to the PATH
         fn wooting_analog_initialise() -> WootingAnalogResult;
 
         /// Returns a bool indicating if the Analog SDK has been initialised