Added the ability to ghenerate proper xml doc for Visual Studio and c… (#149)

* Added the ability to ghenerate proper xml doc for Visual Studio and clean some missing comments

* Fixed typo

Author: 4thlabs

cmake/dotnet/library.csproj.in

@@ -24,6 +24,7 @@
   <PropertyGroup>
     <OutputPath>${CMAKE_LIBRARY_OUTPUT_DIRECTORY}</OutputPath>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   ${_DOTNET_SOURCES}

cmake/unity.cmake

@@ -19,6 +19,7 @@ if (BUILD_UNITY)
         COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:dnr> "${UNITY_RUNTIME_DIRECTORY}/$<TARGET_FILE_NAME:dnr>"
         COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:DolbyIO.Comms.Native> "${UNITY_RUNTIME_DIRECTORY}/$<TARGET_FILE_NAME:DolbyIO.Comms.Native>"
         COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/DolbyIO.Comms.Sdk.dll "${UNITY_ASSEMBLY_DIRECTORY}/DolbyIO.Comms.Sdk.dll"
+        COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/DolbyIO.Comms.Sdk.xml "${UNITY_ASSEMBLY_DIRECTORY}/DolbyIO.Comms.Sdk.xml"
 
         DEPENDS DolbyIO.Comms.Native DolbyIO.Comms.Sdk
     )

src/DolbyIO.Comms.Native/utils.h

@@ -15,7 +15,7 @@ namespace dolbyio::comms::native {
 
   // No op deleter
   struct null_deleter {
-    template<typename T> void operator()(T *t) {};
+    template<typename T> void operator()(T *t) { };
   };
 
   template<typename Exception = std::exception>

src/DolbyIO.Comms.Native/video.cc

@@ -13,9 +13,20 @@ extern "C" {
 
       auto shared = std::shared_ptr<dolbyio::comms::native::video_sink>(sink, null_deleter{});
       wait(sdk->video().remote().set_video_sink(cpp_track, shared));
+
     }}.result();
   }
 
+    EXPORT_API int SetNullVideoSink(video_track track) {
+      return call { [&]() {
+        dolbyio::comms::video_track cpp_track;
+        no_alloc_to_cpp(cpp_track, &track);
+        //auto shared = std::shared_ptr<dolbyio::comms::native::video_sink>(nullptr);
+        //wait(sdk->video().remote().set_video_sink(cpp_track, shared));
+        
+      }}.result();
+    }
+
   EXPORT_API int StartVideo(video_device device, dolbyio::comms::native::video_frame_handler* handler) {
     return call { [&]() {
       camera_device input;

src/DolbyIO.Comms.Sdk/ComponentName.cs

@@ -1,8 +1,18 @@
 namespace DolbyIO.Comms
 {
+    /// <summary>
+    /// The component name.
+    /// </summary>
     public static class ComponentName
     {
+        /// <summary>
+        /// The Unity component name.
+        /// </summary>
         public const string Unity = "unity-sdk";
+
+        /// <summary>
+        /// The dotnet componenet name.
+        /// </summary>
         public const string Dotnet = "dotnet-sdk";
     }
 }

src/DolbyIO.Comms.Sdk/DolbyIOSDK.cs

@@ -137,6 +137,10 @@ public AudioService Audio
 
         private VideoService _video = new VideoService();
 
+        /// <summary>
+        /// Gets the video service.
+        /// </summary>
+        /// <exception cref="DolbyIOException">Is thrown when <see cref="InitAsync(string, RefreshTokenCallBack)"/> has not yet been called.</exception>
         public VideoService Video
         {
             get 
@@ -157,7 +161,11 @@ public VideoService Video
         /// </summary>
         /// <value><c>true</c> if the SDK is initialized; otherwise, <c>false</c>.</value>
         public bool IsInitialized { get => _initialized; }
-
+        
+        /// <summary>
+        /// Create a new DolbyIOSDK
+        /// </summary>
+        /// <param name="componentName">The component used.</param>
         public DolbyIOSDK(string componentName = ComponentName.Dotnet)
         {
             _componentName = componentName;
@@ -194,7 +202,10 @@ public async Task SetLogLevelAsync(LogLevel logLevel)
         {
             await Task.Run(() => Native.CheckException(Native.SetLogLevel(logLevel))).ConfigureAwait(false);
         }
-
+        
+        /// <summary>
+        /// Class finalizer.
+        /// </summary>
         ~DolbyIOSDK()
         {
             Dispose(false);

src/DolbyIO.Comms.Sdk/Native/Handlers.cs

@@ -100,7 +100,7 @@ namespace DolbyIO.Comms
     /// <summary>
     /// The <see cref="DolbyIO.Comms.Services.MediaDeviceService.AudioDeviceRemoved">MediaDevice.AudioRemoved</see> event handler.
     /// </summary>
-    /// <param name="uid">A unique device identifier of the removed audio device.</param>
+    /// <param name="id">A unique device identifier of the removed audio device.</param>
     public delegate void AudioDeviceRemovedEventHandler(DeviceIdentity id);
 
     /// <summary>

src/DolbyIO.Comms.Sdk/Native/Native.cs

@@ -131,6 +131,9 @@ internal static extern int SetSpatialEnvironment(float scaleX, float scaleY, flo
 
         [DllImport (Native.LibName, CharSet = CharSet.Ansi)]
         internal static extern int SetVideoSink(VideoTrack track, VideoSinkHandle handle);
+        
+        [DllImport (Native.LibName, CharSet = CharSet.Ansi)]
+        internal static extern int SetNullVideoSink(VideoTrack track);
 
         [DllImport (Native.LibName, CharSet = CharSet.Ansi)]
         internal static extern int StartVideo(VideoDevice device, VideoFrameHandlerHandle handler);

src/DolbyIO.Comms.Sdk/Native/Structs/AudioDevice.cs

@@ -33,11 +33,13 @@ public struct AudioDevice : IEquatable<DeviceIdentity>,
         [MarshalAs(UnmanagedType.I4)]
         public readonly DeviceDirection Direction;
 
+        /// <inheritdoc/>
         public bool Equals(AudioDevice obj)
         {
             return Native.AudioDeviceEquals(Identity.Value, obj.Identity.Value);
         }
 
+        /// <inheritdoc/>
         public bool Equals(DeviceIdentity id)
         {
             return Native.AudioDeviceEquals(Identity.Value, id.Value);

src/DolbyIO.Comms.Sdk/Native/Structs/Handles/VideoFrame.cs

@@ -25,9 +25,11 @@ internal VideoFrame(int width, int height, IntPtr buffer)
             Height = height;
             SetHandle(buffer);
         }
-
+        
+        /// <inheritdoc/>
         public override bool IsInvalid => handle == IntPtr.Zero || handle == new IntPtr(-1);
 
+        /// <inheritdoc/>
         protected override bool ReleaseHandle()
         {
             return Native.DeleteVideoFrameBuffer(handle);