Commit 9e673635 authored by Ignacio Corderi's avatar Ignacio Corderi
Browse files

Documentation

parent c6592d02

Kinetic.xcodeproj/project.pbxproj

+2 −0
Original line number Diff line number Diff line
@@ -431,6 +431,7 @@ 
			buildSettings = {

				CLANG_ALLOW_NON_MODULAR_INCLUDES_IN_FRAMEWORK_MODULES = YES;

				CLANG_ENABLE_MODULES = YES;

				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;

				COMBINE_HIDPI_IMAGES = YES;

				DEFINES_MODULE = YES;

				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -454,6 +455,7 @@ 
			buildSettings = {

				CLANG_ALLOW_NON_MODULAR_INCLUDES_IN_FRAMEWORK_MODULES = YES;

				CLANG_ENABLE_MODULES = YES;

				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;

				COMBINE_HIDPI_IMAGES = YES;

				DEFINES_MODULE = YES;

				DYLIB_COMPATIBILITY_VERSION = 1;

Kinetic/Session.swift

+11 −0
Original line number Diff line number Diff line
@@ -58,6 +58,17 @@ public class KineticSession { 
        self.sequence = 0

    }

    

    /// Sends a command to the target device and waits for a response

    ///

    /// The type of the result is determined by the command being sent.

    ///

    /// Example:

    /// ```swift

    /// let response = try session.send(cmd)

    /// ```

    ///

    /// - Parameter cmd: The command that will be sent.

    /// - Returns: The response from the device.

    public func send<C: ChannelCommand>(cmd: C) throws -> C.ResponseType {

        // Prepare command contents

        let builder = cmd.build(Builder())