Ableton / LinkKit

iOS SDK for Ableton Link, a new technology that synchronizes musical beat, tempo, and phase across multiple applications running on one or more devices.
http://ableton.github.io/linkkit
Other
147 stars 10 forks source link

Minor header documentation error, causing build warnings #65

Closed michaeltyson closed 2 years ago

michaeltyson commented 2 years ago

Header docs for a couple of methods in ABLLink.h are missing the param name, causing build warnings:

--- LinkKit.xcframework/ios-arm64_i386_x86_64-simulator/Headers/ABLLink.h
+++ LinkKit.xcframework/ios-arm64_i386_x86_64-simulator/Headers/ABLLink.h
@@ -83,7 +83,7 @@ extern "C"

   /*! @brief Called if Session Tempo changes.
    *
-   *  @param the new session tempo in bpm
+   *  @param sessionTempo the new session tempo in bpm
    *
    *  @discussion This is a stable value that is appropriate for display
    *  to the user.
@@ -94,7 +94,7 @@ extern "C"

   /*! @brief Called if Session transport start/stop state changes.
    *
-   *  @param the new start/stop state
+   *  @param isPlaying the new start/stop state
    */
   typedef void (*ABLLinkStartStopCallback)(
     bool isPlaying,
-- 
fgo-ableton commented 2 years ago

Thanks for reporting! What commit are you on? This should have been fixed a while back. https://github.com/Ableton/LinkKit/commit/6c474ebb640240f5791caa20699f665ebb1295b6 We should have a new release soonish.

michaeltyson commented 2 years ago

I'm just on the latest release, 3.1.7 - didn't realise it had since been fixed; excuse the noise!