Fix xml documentation

Author: cabauman

src/Firebase/FirebaseClient.cs

@@ -25,7 +25,7 @@ public class FirebaseClient : IDisposable
         /// Initializes a new instance of the <see cref="FirebaseClient"/> class.
         /// </summary>
         /// <param name="baseUrl"> The base url. </param>
-        /// <param name="offlineDatabaseFactory"> Offline database. </param>  
+        /// <param name="options"> The Firebase options. </param>  
         public FirebaseClient(string baseUrl, FirebaseOptions options = null)
         {
             this.Options = options ?? new FirebaseOptions();

src/Firebase/FirebaseKeyGenerator.cs

@@ -7,7 +7,7 @@ namespace Firebase.Database
     /// Offline key generator which mimics the official Firebase generators. 
     /// Credit: https://github.com/bubbafat/FirebaseSharp/blob/master/src/FirebaseSharp.Portable/FireBasePushIdGenerator.cs
     /// </summary>
-    public class FirebaseKeyGenerator 
+    public static class FirebaseKeyGenerator 
     {
         // Modeled after base64 web-safe chars, but ordered by ASCII.
         private const string PushCharsString = "-0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz";

src/Firebase/FirebaseObject.cs

@@ -1,7 +1,7 @@
 namespace Firebase.Database
 {
     /// <summary>
-    /// Holds the object of type <typeparam name="T" /> along with its key. 
+    /// Holds the object of type <typeparamref name="T" /> along with its key. 
     /// </summary>
     /// <typeparam name="T"> Type of the underlying object. </typeparam> 
     public class FirebaseObject<T> 

src/Firebase/Offline/DatabaseExtensions.cs

@@ -13,6 +13,7 @@ public static class DatabaseExtensions
         /// Create new instances of the <see cref="RealtimeDatabase{T}"/>.
         /// </summary>
         /// <typeparam name="T"> Type of elements. </typeparam>
+        /// <param name="query"> The child query. </param>
         /// <param name="filenameModifier"> Custom string which will get appended to the file name. </param>
         /// <param name="elementRoot"> Optional custom root element of received json items. </param>
         /// <param name="streamingOptions"> Realtime streaming options. </param> 
@@ -30,6 +31,7 @@ public static RealtimeDatabase<T> AsRealtimeDatabase<T>(this ChildQuery query, s
         /// </summary>
         /// <typeparam name="T"> Type of elements. </typeparam>
         /// <typeparam name="TSetHandler"> Type of the custom <see cref="ISetHandler{T}"/> to use. </typeparam>
+        /// <param name="query"> The child query. </param>
         /// <param name="filenameModifier"> Custom string which will get appended to the file name. </param>
         /// <param name="elementRoot"> Optional custom root element of received json items. </param>
         /// <param name="streamingOptions"> Realtime streaming options. </param> 
@@ -46,6 +48,7 @@ public static RealtimeDatabase<T> AsRealtimeDatabase<T, TSetHandler>(this ChildQ
         /// <summary>
         /// Overwrites existing object with given key leaving any missing properties intact in firebase.
         /// </summary>
+        /// <param name="db"> Database instance. </param>
         /// <param name="key"> The key. </param>
         /// <param name="obj"> The object to set. </param>
         /// <param name="syncOnline"> Indicates whether the item should be synced online. </param>
@@ -59,6 +62,7 @@ public static void Patch<T>(this RealtimeDatabase<T> db, string key, T obj, bool
         /// <summary>
         /// Overwrites existing object with given key.
         /// </summary>
+        /// <param name="db"> Database instance. </param>
         /// <param name="key"> The key. </param>
         /// <param name="obj"> The object to set. </param>
         /// <param name="syncOnline"> Indicates whether the item should be synced online. </param>
@@ -72,6 +76,7 @@ public static void Put<T>(this RealtimeDatabase<T> db, string key, T obj, bool s
         /// <summary>
         /// Adds a new entity to the Database.
         /// </summary>
+        /// <param name="db"> Database instance. </param>
         /// <param name="obj"> The object to add.  </param>
         /// <param name="syncOnline"> Indicates whether the item should be synced online. </param>
         /// <param name="priority"> The priority. Objects with higher priority will be synced first. Higher number indicates higher priority. </param>
@@ -89,6 +94,7 @@ public static string Post<T>(this RealtimeDatabase<T> db, T obj, bool syncOnline
         /// <summary>
         /// Deletes the entity with the given key.
         /// </summary>
+        /// <param name="db"> Database instance. </param>
         /// <param name="key"> The key. </param>
         /// <param name="syncOnline"> Indicates whether the item should be synced online. </param>
         /// <param name="priority"> The priority. Objects with higher priority will be synced first. Higher number indicates higher priority. </param> 
@@ -140,7 +146,6 @@ public static void Patch<T, TProperty>(this RealtimeDatabase<T> db, string key,
         /// <param name="db"> Database instance. </param>
         /// <param name="key"> Key of the root element to modify. </param>
         /// <param name="propertyExpression"> Expression on the root element leading to target value to modify. </param>
-        /// <param name="value"> Value to put. </param>
         /// <param name="syncOnline"> Indicates whether the item should be synced online. </param>
         /// <param name="priority"> The priority. Objects with higher priority will be synced first. Higher number indicates higher priority. </param> 
         public static void Delete<T, TProperty>(this RealtimeDatabase<T> db, string key, Expression<Func<T, TProperty>> propertyExpression, bool syncOnline = true, int priority = 1)
@@ -177,7 +182,6 @@ public static void Post<T, TSelector, TProperty>(this RealtimeDatabase<T> db, st
         /// The key of the new entity is automatically generated.
         /// </summary>
         /// <typeparam name="T"> Type of the root elements. </typeparam>
-        /// <typeparam name="TSelector"> Type of the dictionary being modified</typeparam>
         /// <typeparam name="TProperty"> Type of the value within the dictionary being modified</typeparam>
         /// <param name="db"> Database instance. </param>
         /// <param name="key"> Key of the root element to modify. </param>

src/Firebase/Offline/OfflineEntry.cs

@@ -16,8 +16,10 @@ public class OfflineEntry
         /// </summary>
         /// <param name="key"> The key. </param>
         /// <param name="obj"> The object. </param>
-        /// <param name="priority"> The priority. Objects with higher priority will be synced first. Higher number indicates higher priority. </param>  
+        /// <param name="data"> The json data. </param>
+        /// <param name="priority"> The priority. Objects with higher priority will be synced first. Higher number indicates higher priority. </param>
         /// <param name="syncOptions"> The sync options. </param>
+        /// <param name="isPartial"> A value indicating whether this is only a partial object. </param>
         public OfflineEntry(string key, object obj, string data, int priority, SyncOptions syncOptions, bool isPartial = false)
         {
             this.Key = key;
@@ -37,6 +39,7 @@ public OfflineEntry(string key, object obj, string data, int priority, SyncOptio
         /// <param name="obj"> The object. </param>
         /// <param name="priority"> The priority. Objects with higher priority will be synced first. Higher number indicates higher priority. </param>  
         /// <param name="syncOptions"> The sync options. </param>
+        /// <param name="isPartial"> A value indicating whether this is only a partial object. </param>
         public OfflineEntry(string key, object obj, int priority, SyncOptions syncOptions, bool isPartial = false)
             : this(key, obj, JsonConvert.SerializeObject(obj), priority, syncOptions, isPartial)
         {

src/Firebase/Offline/RealtimeDatabase.cs

@@ -43,9 +43,10 @@ public partial class RealtimeDatabase<T> : IDisposable where T : class
         /// <param name="elementRoot"> The element Root. </param>
         /// <param name="offlineDatabaseFactory"> The offline database factory.  </param>
         /// <param name="filenameModifier"> Custom string which will get appended to the file name.  </param>
-        /// <param name="streamChanges"> Specifies whether changes should be streamed from the server.  </param>
-        /// <param name="pullEverythingOnStart"> Specifies if everything should be pull from the online storage on start. It only makes sense when <see cref="streamChanges"/> is set to true. </param>
+        /// <param name="streamingOptions"> Specifies condition for which items get streamed. </param>
+        /// <param name="initialPullStrategy"> Specifies the strategy for initial pull of server data. </param>
         /// <param name="pushChanges"> Specifies whether changed items should actually be pushed to the server. If this is false, then Put / Post / Delete will not affect server data. </param>
+        /// <param name="setHandler"></param>
         public RealtimeDatabase(ChildQuery childQuery, string elementRoot, Func<Type, string, IDictionary<string, OfflineEntry>> offlineDatabaseFactory, string filenameModifier, StreamingOptions streamingOptions, InitialPullStrategy initialPullStrategy, bool pushChanges, ISetHandler<T> setHandler = null)
         {
             this.childQuery = childQuery;
@@ -93,7 +94,7 @@ public ISetHandler<T> PutHandler
         /// </summary>
         /// <param name="key"> The key. </param>
         /// <param name="obj"> The object to set. </param>
-        /// <param name="syncOnline"> Indicates whether the item should be synced online. </param>
+        /// <param name="syncOptions"> Specifies type of sync requested for given data. </param>
         /// <param name="priority"> The priority. Objects with higher priority will be synced first. Higher number indicates higher priority. </param>
         public void Set(string key, T obj, SyncOptions syncOptions, int priority = 1)
         {

src/Firebase/Query/FirebaseQuery.cs

@@ -109,6 +109,7 @@ public async Task<T> OnceSingleAsync<T>(TimeSpan? timeout = null)
         /// Starts observing this query watching for changes real time sent by the server.
         /// </summary>
         /// <typeparam name="T"> Type of elements. </typeparam>
+        /// <param name="exceptionHandler"> Optional exception handler for the stream subscription. </param>
         /// <param name="elementRoot"> Optional custom root element of received json items. </param>
         /// <returns> Observable stream of <see cref="FirebaseEvent{T}"/>. </returns>
         public IObservable<FirebaseEvent<T>> AsObservable<T>(EventHandler<ContinueExceptionEventArgs<FirebaseException>> exceptionHandler = null, string elementRoot = "")
@@ -140,10 +141,9 @@ public async Task<string> BuildUrlAsync()
         /// <summary>
         /// Posts given object to repository.
         /// </summary>
-        /// <param name="obj"> The object. </param>
+        /// <param name="data"> The json data. </param>
         /// <param name="generateKeyOffline"> Specifies whether the key should be generated offline instead of online. </param>
         /// <param name="timeout"> Optional timeout value. </param>
-        /// <typeparam name="T"> Type of <see cref="obj"/> </typeparam>
         /// <returns> Resulting firebase object with populated key. </returns>
         public async Task<FirebaseObject<string>> PostAsync(string data, bool generateKeyOffline = true, TimeSpan? timeout = null)
         {
@@ -168,9 +168,8 @@ public async Task<FirebaseObject<string>> PostAsync(string data, bool generateKe
         /// <summary>
         /// Patches data at given location instead of overwriting them.
         /// </summary> 
-        /// <param name="obj"> The object. </param>
+        /// <param name="data"> The json data. </param>
         /// <param name="timeout"> Optional timeout value. </param>
-        /// <typeparam name="T"> Type of <see cref="obj"/> </typeparam>
         /// <returns> The <see cref="Task"/>. </returns>
         public Task PatchAsync(string data, TimeSpan? timeout = null)
         {
@@ -182,9 +181,8 @@ public Task PatchAsync(string data, TimeSpan? timeout = null)
         /// <summary>
         /// Sets or overwrites data at given location.
         /// </summary> 
-        /// <param name="obj"> The object. </param>
+        /// <param name="data"> The json data. </param>
         /// <param name="timeout"> Optional timeout value. </param>
-        /// <typeparam name="T"> Type of <see cref="obj"/> </typeparam>
         /// <returns> The <see cref="Task"/>. </returns>
         public Task PutAsync(string data, TimeSpan? timeout = null)
         {

src/Firebase/Query/QueryExtensions.cs

@@ -54,7 +54,7 @@ public static ChildQuery Child(this ChildQuery node, string path)
         }
 
         /// <summary>
-        /// Order data by given <see cref="propertyName"/>. Note that this is used mainly for following filtering queries and due to firebase implementation
+        /// Order data by given <paramref name="propertyName"/>. Note that this is used mainly for following filtering queries and due to firebase implementation
         /// the data may actually not be ordered.
         /// </summary>
         /// <param name="child"> The child. </param>
@@ -66,7 +66,7 @@ public static OrderQuery OrderBy(this ChildQuery child, string propertyName)
         }
 
         /// <summary>
-        /// Instructs firebase to send data greater or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data greater or equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -77,7 +77,7 @@ public static FilterQuery StartAt(this ParameterQuery child, string value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data lower or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data lower or equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -88,7 +88,7 @@ public static FilterQuery EndAt(this ParameterQuery child, string value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -99,7 +99,7 @@ public static FilterQuery EqualTo(this ParameterQuery child, string value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data greater or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data greater or equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -110,7 +110,7 @@ public static FilterQuery StartAt(this ParameterQuery child, double value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data lower or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data lower or equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -121,7 +121,7 @@ public static FilterQuery EndAt(this ParameterQuery child, double value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -132,7 +132,7 @@ public static FilterQuery EqualTo(this ParameterQuery child, double value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data greater or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data greater or equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -143,7 +143,7 @@ public static FilterQuery StartAt(this ParameterQuery child, long value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data lower or equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data lower or equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -154,7 +154,7 @@ public static FilterQuery EndAt(this ParameterQuery child, long value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -165,7 +165,7 @@ public static FilterQuery EqualTo(this ParameterQuery child, long value)
         }
 
         /// <summary>
-        /// Instructs firebase to send data equal to the <see cref="value"/>. This must be preceded by an OrderBy query.
+        /// Instructs firebase to send data equal to the <paramref name="value"/>. This must be preceded by an OrderBy query.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="value"> Value to start at. </param>
@@ -186,7 +186,7 @@ public static FilterQuery EqualTo(this ParameterQuery child)
         }        
 
         /// <summary>
-        /// Limits the result to first <see cref="count"/> items.
+        /// Limits the result to first <paramref name="count"/> items.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="count"> Number of elements. </param>
@@ -197,7 +197,7 @@ public static FilterQuery LimitToFirst(this ParameterQuery child, int count)
         }
 
         /// <summary>
-        /// Limits the result to last <see cref="count"/> items.
+        /// Limits the result to last <paramref name="count"/> items.
         /// </summary>
         /// <param name="child"> Current node. </param>
         /// <param name="count"> Number of elements. </param>
@@ -231,7 +231,7 @@ public static async Task<FirebaseObject<T>> PostAsync<T>(this FirebaseQuery quer
         /// <param name="query"> Current node. </param>
         /// <param name="item"> Object to fan out. </param>
         /// <param name="relativePaths"> Locations where to store the item. </param>
-        public static Task FanOut<T>(this ChildQuery child, T item, params string[] relativePaths)
+        public static Task FanOut<T>(this ChildQuery query, T item, params string[] relativePaths)
         {
             if (relativePaths == null)
             {
@@ -245,7 +245,7 @@ public static Task FanOut<T>(this ChildQuery child, T item, params string[] rela
                 fanoutObject.Add(path, item);
             }
 
-            return child.PatchAsync(fanoutObject);
+            return query.PatchAsync(fanoutObject);
         }
     }
 }