Updated/Clarified doc comments (#276)

Author: smaillet

IgnoredWords.dic

@@ -72,6 +72,7 @@ Identifier
 Impl
 inline
 inlined
+inlining
 Interop
 jit
 len

src/Interop/Ubiquity.NET.Llvm.Interop/ArchitectureExtensions.cs

@@ -7,7 +7,7 @@ namespace Ubiquity.NET.Llvm.Interop
     /// <summary>Utility class to implement extensions of <see cref="Architecture"/></summary>
     public static class ArchitectureExtensions
     {
-        /// <summary>Converts a <see cref="Architecture"/> to a <see cref="LibLLVMCodeGenTarget"/></summary>
+        /// <summary>Converts an <see cref="Architecture"/> to a <see cref="LibLLVMCodeGenTarget"/></summary>
         /// <param name="arch">Value to convert</param>
         /// <returns>LLVM code generation target</returns>
         /// <exception cref="NotSupportedException">Native LLVM form of target is unknown</exception>

src/Interop/Ubiquity.NET.Llvm.Interop/Library.cs

@@ -68,6 +68,7 @@ public static ILibLlvm InitializeLLVM( )
                                           , SupportedVersion.ToString()
                                           , libVersion.ToString()
                                           );
+
                 throw new InvalidOperationException( msg );
             }
 

src/Ubiquity.NET.InteropHelpers/LazyEncodedString.cs

@@ -140,9 +140,9 @@ public MemoryHandle Pin( )
         /// <inheritdoc/>
         /// <remarks>
         /// May incur the cost of conversion to native if both strings don't have the same
-        /// form. This only performs an ordinal comparison of the values. If both have, a
-        /// managed representation already that is used, otherwise the native data is used
-        /// for the comparison.
+        /// form. If both have, a managed representation already that is used, otherwise the
+        /// native data is used for the comparison. This only performs an ordinal comparison
+        /// of the values.
         /// </remarks>
         public bool Equals( LazyEncodedString? other )
         {

src/Ubiquity.NET.InteropHelpers/LazyEncodedStringMarshaller.cs

@@ -30,7 +30,7 @@ public static unsafe class LazyEncodedStringMarshaller
         }
 
         // Generally, can't support the [In] direction of [Out,In]
-        // The initialized "in" array might be marshaled to the native where it is "updated" and then need marshaled
+        // The initialized "in" array might be marshaled to the native where it is "updated" and then needs marshaling
         // again on the return. This is NOT a supported scenario as conversion would need a stateful form to hold
         // a pinned element for the call. Thus the generated marshalling would need to hold an array of the pinned
         // managed values and unpin them after the call..., which is not an option for array elements.

src/Ubiquity.NET.InteropHelpers/SafeGCHandle.cs

@@ -29,7 +29,10 @@ namespace Ubiquity.NET.InteropHelpers
     /// is, by holding a <see cref="GCHandle"/> to self, with an AddRef'd handle the instance
     /// would live until the app is terminated! Thus applications using this MUST understand
     /// the native code use and account for the disposable of any instances with this as a
-    /// member.</para>
+    /// member. Typically a callback provided to the native code is used to indicate release
+    /// of the resource. That callback will call dispose to decrement the refcount on the
+    /// handle. If the ref count lands at 0, then the object it refers to is subject to
+    /// normal GC.</para>
     /// </remarks>
     public sealed class SafeGCHandle
         : SafeHandle