summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Gluck <justin.gluck@livio.io>2019-11-07 13:15:18 -0500
committerJustin Gluck <justin.gluck@livio.io>2019-11-07 13:15:18 -0500
commit2894e823398d659e1f3ffe78d170cb7bf6304f81 (patch)
tree741b47b9be3db54fee884252395b12a65ba4aff4
parent92f913aa0580520f8556e9dab195bfe788738f6d (diff)
downloadsdl_ios-2894e823398d659e1f3ffe78d170cb7bf6304f81.tar.gz
pr issues
-rw-r--r--SmartDeviceLink/SDLFileManager.h3
-rw-r--r--SmartDeviceLink/SDLGetSystemCapability.h5
-rw-r--r--SmartDeviceLink/SDLHybridAppPreference.h2
-rw-r--r--SmartDeviceLink/SDLLightState.h2
-rw-r--r--SmartDeviceLink/SDLProtocolConstants.h44
5 files changed, 9 insertions, 47 deletions
diff --git a/SmartDeviceLink/SDLFileManager.h b/SmartDeviceLink/SDLFileManager.h
index c53a5410b..91a0201d5 100644
--- a/SmartDeviceLink/SDLFileManager.h
+++ b/SmartDeviceLink/SDLFileManager.h
@@ -18,7 +18,8 @@
NS_ASSUME_NONNULL_BEGIN
-/// The handler that is called when the manager is set up or failed to set up with an error
+/// The handler that is called when the manager is set up or failed to set up with an error.
+/// This is for internal use only.
///
/// @param success True if every request succeeded, false if any failed.
/// @param error The error that occurred during the request if any occurred.
diff --git a/SmartDeviceLink/SDLGetSystemCapability.h b/SmartDeviceLink/SDLGetSystemCapability.h
index e47484b25..faaac72d3 100644
--- a/SmartDeviceLink/SDLGetSystemCapability.h
+++ b/SmartDeviceLink/SDLGetSystemCapability.h
@@ -13,8 +13,11 @@
NS_ASSUME_NONNULL_BEGIN
-/**SDLGetWayPoints.
+/**
+ * SDLGetWayPoints.
* Request for expanded information about a supported system/HMI capability
+ *
+ * @since SDL 4.5
*/
@interface SDLGetSystemCapability : SDLRPCRequest
diff --git a/SmartDeviceLink/SDLHybridAppPreference.h b/SmartDeviceLink/SDLHybridAppPreference.h
index ac456a237..171edba2c 100644
--- a/SmartDeviceLink/SDLHybridAppPreference.h
+++ b/SmartDeviceLink/SDLHybridAppPreference.h
@@ -13,7 +13,7 @@
*/
typedef SDLEnum SDLHybridAppPreference SDL_SWIFT_ENUM;
-/**SDLImageResolution.h
+/**
* App preference of mobile.
*/
extern SDLHybridAppPreference const SDLHybridAppPreferenceMobile;
diff --git a/SmartDeviceLink/SDLLightState.h b/SmartDeviceLink/SDLLightState.h
index a21957e24..faaaad272 100644
--- a/SmartDeviceLink/SDLLightState.h
+++ b/SmartDeviceLink/SDLLightState.h
@@ -11,6 +11,8 @@
NS_ASSUME_NONNULL_BEGIN
/// Current light control state
+///
+/// @since SDL 5.0
@interface SDLLightState : SDLRPCStruct
/**
diff --git a/SmartDeviceLink/SDLProtocolConstants.h b/SmartDeviceLink/SDLProtocolConstants.h
index d4e442531..6da05c02e 100644
--- a/SmartDeviceLink/SDLProtocolConstants.h
+++ b/SmartDeviceLink/SDLProtocolConstants.h
@@ -20,8 +20,6 @@ typedef NS_ENUM(UInt8, SDLFrameType) {
/// The First Frame in a multiple frame payload contains information about the entire sequence of frames so that the receiving end can correctly parse all the frames and reassemble the entire payload. The payload of this frame is only eight bytes and contains information regarding the rest of the sequence.
SDLFrameTypeFirst = 0x02,
- ///SDLFrameType
- ///
/// The Consecutive Frames in a multiple frame payload contain the actual raw data of the original payload. The parsed payload contained in each of the Consecutive Frames' payloads should be buffered until the entire sequence is complete.
SDLFrameTypeConsecutive = 0x03
};
@@ -30,28 +28,18 @@ typedef NS_ENUM(UInt8, SDLFrameType) {
* The data packet's format and priority.
*/
typedef NS_ENUM(UInt8, SDLServiceType) {
- /// SDLServiceType
- ///
/// The lowest level service available.
SDLServiceTypeControl = 0x00,
- /// SDLServiceType
- ///
/// Used to send requests, responses, and notifications between an application and a head unit.
SDLServiceTypeRPC NS_SWIFT_NAME(rpc) = 0x07,
- /// SDLServiceType
- ///
/// The application can start the audio service to send PCM audio data to the head unit. After the StartService packet is sent and the ACK received, the payload for the Audio Service is only PCM audio data.
SDLServiceTypeAudio = 0x0A,
- /// SDLServiceType
- ///
/// The application can start the video service to send H.264 video data to the head unit. After the StartService packet is sent and the ACK received, the payload for the Video Service is only H.264 video data.
SDLServiceTypeVideo = 0x0B,
- /// SDLServiceType
- ///
/// Similar to the RPC Service but adds a bulk data field. The payload of a message sent via the Hybrid service consists of a Binary Header, JSON Data, and Bulk Data.
SDLServiceTypeBulkData = 0x0F
};
@@ -60,83 +48,51 @@ typedef NS_ENUM(UInt8, SDLServiceType) {
* The data packet's available data.
*/
typedef NS_ENUM(UInt8, SDLFrameInfo) {
- /// SDLFrameInfo
- ///
/// A ping packet that is sent to ensure the connection is still active and the service is still valid.
SDLFrameInfoHeartbeat = 0x00,
- /// SDLFrameInfo
- ///
/// Requests that a specific type of service is started.
SDLFrameInfoStartService = 0x01,
- /// SDLFrameInfo
- ///
/// Acknowledges that the specific service has been started successfully.
SDLFrameInfoStartServiceACK = 0x02,
- /// SDLFrameInfo
- ///
/// Negatively acknowledges that the specific service was not started.
SDLFrameInfoStartServiceNACK = 0x03,
- /// SDLFrameInfo
- ///
/// Requests that a specific type of service is ended.
SDLFrameInfoEndService = 0x04,
- /// SDLFrameInfo
- ///
/// Acknowledges that the specific service has been ended successfully.
SDLFrameInfoEndServiceACK = 0x05,
- /// SDLFrameInfo
- ///
/// Negatively acknowledges that the specific service was not ended or has not yet been started.
SDLFrameInfoEndServiceNACK = 0x06,
- /// SDLFrameInfo
- ///
/// Notifies that a Secondary Transport has been established.
SDLFrameInfoRegisterSecondaryTransport = 0x07,
- /// SDLFrameInfo
- ///
/// Acknowledges that the Secondary Transport has been recognized.
SDLFrameInfoRegisterSecondaryTransportACK = 0x08,
- /// SDLFrameInfo
- ///
/// Negatively acknowledges that the Secondary Transport has not been recognized.
SDLFrameInfoRegisterSecondaryTransportNACK = 0x09,
- /// SDLFrameInfo
- ///
/// Indicates the status or configuration of transport(s) is/are updated.
SDLFrameInfoTransportEventUpdate = 0xFD,
- /// SDLFrameInfo
- ///
/// Deprecated.
SDLFrameInfoServiceDataAck = 0xFE,
- /// SDLFrameInfo
- ///
/// Acknowledges that a Heartbeat control packet has been received.
SDLFrameInfoHeartbeatACK = 0xFF,
- /// SDLFrameInfo
- ///
/// Payload contains a single packet.
SDLFrameInfoSingleFrame = 0x00, // If frameType == Single (0x01)
- /// SDLFrameInfo
- ///
/// First frame in a multiple frame payload.
SDLFrameInfoFirstFrame = 0x00, // If frameType == First (0x02)
- /// SDLFrameInfo
- ///
/// Frame in a multiple frame payload.
SDLFrameInfoConsecutiveLastFrame = 0x00 // If frametype == Consecutive (0x03)
};