Enable XML doc generation and add docs to BinarySearch/InsertSorted

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: rafalmaciag

Source/ModelingEvolution.Observable/ModelingEvolution.Observable.csproj

@@ -13,7 +13,7 @@
     <PackageDescription>Minimal classes for Observable</PackageDescription>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <RepositoryUrl>https://github.com/modelingevolution/observable</RepositoryUrl>
-    <GenerateDocumentationFile>False</GenerateDocumentationFile>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <Copyright>ModelingEvolution</Copyright>
     <Authors>ModelingEvolution Team</Authors>
   </PropertyGroup>

Source/ModelingEvolution.Observable/ObservableCollection.cs

@@ -42,9 +42,18 @@ public ObservableCollection(List<T> list)
     public void Move(int oldIndex, int newIndex) => MoveItem(oldIndex, newIndex);
 
     /// <summary>
-    /// Binary search on a sorted collection. Returns the index of the item if found,
-    /// or the bitwise complement (~index) of the insertion point if not found.
+    /// Performs a binary search on a sorted collection.
+    /// The collection must already be sorted according to <paramref name="comparer"/>
+    /// (or <see cref="Comparer{T}.Default"/> when <c>null</c>).
     /// </summary>
+    /// <param name="item">The item to search for.</param>
+    /// <param name="comparer">
+    /// The comparer to use. When <c>null</c>, <see cref="Comparer{T}.Default"/> is used.
+    /// </param>
+    /// <returns>
+    /// The zero-based index of <paramref name="item"/> if found;
+    /// otherwise, the bitwise complement (<c>~index</c>) of the insertion point.
+    /// </returns>
     public int BinarySearch(T item, IComparer<T>? comparer = null)
     {
         comparer ??= Comparer<T>.Default;
@@ -62,8 +71,13 @@ public int BinarySearch(T item, IComparer<T>? comparer = null)
 
     /// <summary>
     /// Inserts an item into the collection maintaining sorted order.
-    /// Uses binary search to find the correct insertion point.
+    /// Uses <see cref="BinarySearch"/> to find the correct insertion point
+    /// and raises <see cref="CollectionChanged"/>.
     /// </summary>
+    /// <param name="item">The item to insert.</param>
+    /// <param name="comparer">
+    /// The comparer to use. When <c>null</c>, <see cref="Comparer{T}.Default"/> is used.
+    /// </param>
     public void InsertSorted(T item, IComparer<T>? comparer = null)
     {
         int index = BinarySearch(item, comparer);