Updates in RestCommClient: No news from appledoc; switched to Doxygen. This is a first attempt at the reference documentation :)

Author: atsakiridis

RestCommClient/RestCommClient.xcodeproj/project.pbxproj

@@ -6,6 +6,20 @@
 	objectVersion = 46;
 	objects = {
 
+/* Begin PBXAggregateTarget section */
+		AE72641A19F4302E000AE2ED /* Documentation */ = {
+			isa = PBXAggregateTarget;
+			buildConfigurationList = AE72641D19F4302E000AE2ED /* Build configuration list for PBXAggregateTarget "Documentation" */;
+			buildPhases = (
+				AE72641E19F43037000AE2ED /* ShellScript */,
+			);
+			dependencies = (
+			);
+			name = Documentation;
+			productName = Documentation;
+		};
+/* End PBXAggregateTarget section */
+
 /* Begin PBXBuildFile section */
 		AE1AB97E19EA7FB20002ECFA /* libsofia-sip-ua.a in Frameworks */ = {isa = PBXBuildFile; fileRef = AE1AB97D19EA7FB20002ECFA /* libsofia-sip-ua.a */; };
 		AEA6C4B119DB412A00BD2455 /* sdp_utils.cpp in Sources */ = {isa = PBXBuildFile; fileRef = AEA6C4A219DB412A00BD2455 /* sdp_utils.cpp */; };
@@ -590,6 +604,7 @@
 			targets = (
 				AEC1220B19728C850035B864 /* RestCommClient */,
 				AEC1221B19728C850035B864 /* RestCommClientTests */,
+				AE72641A19F4302E000AE2ED /* Documentation */,
 			);
 		};
 /* End PBXProject section */
@@ -605,6 +620,22 @@
 		};
 /* End PBXResourcesBuildPhase section */
 
+/* Begin PBXShellScriptBuildPhase section */
+		AE72641E19F43037000AE2ED /* ShellScript */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "cd \"${PROJECT_DIR}/doc\"\n/opt/local/bin/doxygen Doxyfile";
+		};
+/* End PBXShellScriptBuildPhase section */
+
 /* Begin PBXSourcesBuildPhase section */
 		AEC1220819728C850035B864 /* Sources */ = {
 			isa = PBXSourcesBuildPhase;
@@ -656,6 +687,20 @@
 /* End PBXVariantGroup section */
 
 /* Begin XCBuildConfiguration section */
+		AE72641B19F4302E000AE2ED /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				PRODUCT_NAME = "$(TARGET_NAME)";
+			};
+			name = Debug;
+		};
+		AE72641C19F4302E000AE2ED /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				PRODUCT_NAME = "$(TARGET_NAME)";
+			};
+			name = Release;
+		};
 		AEC1222D19728C850035B864 /* Debug */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
@@ -815,6 +860,14 @@
 /* End XCBuildConfiguration section */
 
 /* Begin XCConfigurationList section */
+		AE72641D19F4302E000AE2ED /* Build configuration list for PBXAggregateTarget "Documentation" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				AE72641B19F4302E000AE2ED /* Debug */,
+				AE72641C19F4302E000AE2ED /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+		};
 		AEC1220719728C850035B864 /* Build configuration list for PBXProject "RestCommClient" */ = {
 			isa = XCConfigurationList;
 			buildConfigurations = (

RestCommClient/RestCommClient/RCConnection.h

@@ -11,15 +11,17 @@
 #import "RCConnectionDelegate.h"
 #import "SipManager.h"
 
+/** @file RCConnection.h */
+
 /**
- Connection State
+ * Connection State
  */
 typedef enum
 {
-	RCConnectionStatePending = 0,  /** Connection is in state pending */
-	RCConnectionStateConnecting,  /** Connection is in state connecting */
-	RCConnectionStateConnected,  /** Connection is in state connected */
-	RCConnectionStateDisconnected  /** Connection is in state disconnected */
+	RCConnectionStatePending = 0,  /**< Connection is in state pending */
+	RCConnectionStateConnecting,  /**< Connection is in state connecting */
+	RCConnectionStateConnected,  /**< Connection is in state connected */
+	RCConnectionStateDisconnected  /**< Connection is in state disconnected */
 } RCConnectionState;
 
 
@@ -77,7 +79,7 @@ extern NSString* const RCConnectionIncomingParameterCallSIDKey;
 - (void)accept;
 
 /**
- *  Ignore connection
+ *  Ignore connection (not implemented)
  */
 - (void)ignore;
 
@@ -92,7 +94,7 @@ extern NSString* const RCConnectionIncomingParameterCallSIDKey;
 - (void)disconnect;
 
 /**
- *  Send DTMF tones over a connection that is in state 'RCConnectionStateConnected'
+ *  Send DTMF tones over a connection that is in state 'RCConnectionStateConnected' (not implemented)
  *
  *  @param digits A string of digits that will be sent
  */

RestCommClient/RestCommClient/RCConnectionDelegate.h

@@ -8,6 +8,8 @@
 
 #import <Foundation/Foundation.h>
 
+/** @file RCConnectionDelegate.h */
+
 @class RCConnection;
 
 /**

RestCommClient/RestCommClient/RCDevice.h

@@ -12,13 +12,15 @@
 #import "RCConnectionDelegate.h"
 #import "SipManager.h"
 
+/** @file RCDevice.h */
+
 /**
- Device State
+ * Device State
  */
 typedef enum {
-    RCDeviceStateOffline = 0,  /** Device is offline */
-	RCDeviceStateReady,  /** Device is ready to make and receive connections */
-	RCDeviceStateBusy  /** Device is busy */
+    RCDeviceStateOffline = 0,  /**< Device is offline */
+	RCDeviceStateReady,  /**< Device is ready to make and receive connections */
+	RCDeviceStateBusy  /**< Device is busy */
 } RCDeviceState;
 
 extern NSString* const RCDeviceCapabilityIncomingKey;
@@ -29,36 +31,35 @@ extern NSString* const RCDeviceCapabilityApplicationSIDKey;
 extern NSString* const RCDeviceCapabilityApplicationParametersKey;
 extern NSString* const RCDeviceCapabilityClientNameKey;
 
-
 @class RCConnection;
 
 /**
  *  Represents an abstraction of a communication device able to make and receive calls, send and receive messages etc
  */
-@interface RCDevice : NSObject <SipManagerDeviceDelegate,NSURLConnectionDelegate>
+@interface RCDevice : NSObject<SipManagerDeviceDelegate, NSURLConnectionDelegate>
 /**
  *  Device state
  */
 @property (nonatomic, readonly) RCDeviceState state;
+
 /**
  *  Device capabilities
  */
-
 @property (nonatomic, readonly) NSDictionary* capabilities;
+
 /**
  *  Delegate that will be receiving RCDevice events
  */
-
 @property (nonatomic, assign) id<RCDeviceDelegate> delegate;
+
 /**
  *  Sound for incoming connections enabled
  */
-
 @property (nonatomic) BOOL incomingSoundEnabled;
+
 /**
  *  Sound for outgoing connections enabled
  */
-
 @property (nonatomic) BOOL outgoingSoundEnabled;
 
 /**
@@ -82,14 +83,14 @@ extern NSString* const RCDeviceCapabilityClientNameKey;
 - (void)listen;
 
 /**
- *  Stop listening for incoming connections
+ *  Stop listening for incoming connections (not implemented)
  */
 - (void)unlisten;
 
 /**
  *  Update Capability Token
  *
- *  @param capabilityToken New Capability Token
+ *  @param capabilityToken New Capability Token (not implemented)
  */
 - (void)updateCapabilityToken:(NSString*)capabilityToken;
 
@@ -112,7 +113,7 @@ extern NSString* const RCDeviceCapabilityClientNameKey;
 - (void)sendMessage:(NSString*)message to:(NSDictionary*)receiver;
 
 /**
- *  Disconnect all connections
+ *  Disconnect all connections (not implemented)
  */
 - (void)disconnectAll;
 
@@ -122,5 +123,5 @@ extern NSString* const RCDeviceCapabilityClientNameKey;
  *  @param params Dictionary of key/value pairs of the parameters that will be updated
  */
 - (void) updateParams:(NSDictionary*)params;
+@end
 
-@end

RestCommClient/RestCommClient/RCDevice.m

@@ -111,7 +111,6 @@ - (void)sendMessage:(NSString*)message to:(NSDictionary*)parameters
 - (void)disconnectAll
 {
     NSLog(@"[RCDevice disconnectAll]");
-    
 }
 
 #pragma mark SipManager Delegate methods

RestCommClient/RestCommClient/RCDeviceDelegate.h

@@ -6,6 +6,8 @@
 //  Copyright (c) 2014 TeleStax. All rights reserved.
 //
 
+/** @file RCDeviceDelegate.h */
+
 @class RCDevice;
 @class RCConnection;
 @class RCPresenceEvent;
@@ -14,6 +16,7 @@
  *  RCDevice notifies its delegate for events defined in this delegate protocol
  */
 @protocol RCDeviceDelegate<NSObject>
+
 @required
 /**
  *  Device stoped listening for incoming connections
@@ -54,4 +57,5 @@
  *  @param message Instant message
  */
 - (void)device:(RCDevice *)device didReceiveIncomingMessage:(NSString *)message;
-@end
+@end
+