Skip to content

Commit 3bffda4

Browse files
author
Tomas Bezouska
committed
Added comments
1 parent c014217 commit 3bffda4

File tree

3 files changed

+49
-3
lines changed

3 files changed

+49
-3
lines changed

src/Firebase/Query/FilterQuery.cs

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,44 @@
11
namespace Firebase.Database.Query
22
{
33
/// <summary>
4-
/// Represents a firebase filtering query, e.g. "?LimitToLast=10"
4+
/// Represents a firebase filtering query, e.g. "?LimitToLast=10".
55
/// </summary>
66
public class FilterQuery : ParameterQuery
77
{
88
private readonly string value;
99
private readonly double? doubleValue;
1010

11+
/// <summary>
12+
/// Initializes a new instance of the <see cref="FilterQuery"/> class.
13+
/// </summary>
14+
/// <param name="parent"> The parent. </param>
15+
/// <param name="filter"> The filter. </param>
16+
/// <param name="value"> The value for filter. </param>
17+
/// <param name="client"> The owning client. </param>
1118
public FilterQuery(FirebaseQuery parent, string filter, string value, FirebaseClient client)
1219
: base(parent, filter, client)
1320
{
1421
this.value = value;
1522
}
1623

24+
/// <summary>
25+
/// Initializes a new instance of the <see cref="FilterQuery"/> class.
26+
/// </summary>
27+
/// <param name="parent"> The parent. </param>
28+
/// <param name="filter"> The filter. </param>
29+
/// <param name="value"> The value for filter. </param>
30+
/// <param name="client"> The owning client. </param>
1731
public FilterQuery(FirebaseQuery parent, string filter, double value, FirebaseClient client)
1832
: base(parent, filter, client)
1933
{
2034
this.doubleValue = value;
2135
}
2236

37+
/// <summary>
38+
/// The build url parameter.
39+
/// </summary>
40+
/// <param name="child"> The child. </param>
41+
/// <returns> Url parameter part of the resulting path. </returns>
2342
protected override string BuildUrlParameter(FirebaseQuery child)
2443
{
2544
if (this.value != null)

src/Firebase/Query/OrderQuery.cs

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
11
namespace Firebase.Database.Query
22
{
33
/// <summary>
4-
/// Represents a firebase ordering query, e.g. "?OrderBy=Foo"
4+
/// Represents a firebase ordering query, e.g. "?OrderBy=Foo".
55
/// </summary>
66
public class OrderQuery : ParameterQuery
77
{
88
private readonly string propertyName;
99

10+
/// <summary>
11+
/// Initializes a new instance of the <see cref="OrderQuery"/> class.
12+
/// </summary>
13+
/// <param name="parent"> The query parent. </param>
14+
/// <param name="propertyName"> The property name. </param>
15+
/// <param name="client"> The owning client. </param>
1016
public OrderQuery(ChildQuery parent, string propertyName, FirebaseClient client)
1117
: base(parent, "orderBy", client)
1218
{
1319
this.propertyName = propertyName;
1420
}
1521

22+
/// <summary>
23+
/// The build url parameter.
24+
/// </summary>
25+
/// <param name="child"> The child. </param>
26+
/// <returns> The <see cref="string"/>. </returns>
1627
protected override string BuildUrlParameter(FirebaseQuery child)
1728
{
1829
return $"\"{this.propertyName}\"";

src/Firebase/Query/ParameterQuery.cs

+17-1
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,41 @@
11
namespace Firebase.Database.Query
22
{
33
/// <summary>
4-
/// Represents a parameter in firebase query, e.g. "?data=foo"
4+
/// Represents a parameter in firebase query, e.g. "?data=foo".
55
/// </summary>
66
public abstract class ParameterQuery : FirebaseQuery
77
{
88
private readonly string parameter;
99
private readonly string separator;
1010

11+
/// <summary>
12+
/// Initializes a new instance of the <see cref="ParameterQuery"/> class.
13+
/// </summary>
14+
/// <param name="parent"> The parent of this query. </param>
15+
/// <param name="parameter"> The parameter. </param>
16+
/// <param name="client"> The owning client. </param>
1117
protected ParameterQuery(FirebaseQuery parent, string parameter, FirebaseClient client)
1218
: base(parent, client)
1319
{
1420
this.parameter = parameter;
1521
this.separator = (this.Parent is ChildQuery) ? "?" : "&";
1622
}
1723

24+
/// <summary>
25+
/// Build the url segment represented by this query.
26+
/// </summary>
27+
/// <param name="child"> The child. </param>
28+
/// <returns> The <see cref="string"/>. </returns>
1829
protected override string BuildUrlSegment(FirebaseQuery child)
1930
{
2031
return $"{this.separator}{this.parameter}={this.BuildUrlParameter(child)}";
2132
}
2233

34+
/// <summary>
35+
/// The build url parameter.
36+
/// </summary>
37+
/// <param name="child"> The child. </param>
38+
/// <returns> The <see cref="string"/>. </returns>
2339
protected abstract string BuildUrlParameter(FirebaseQuery child);
2440
}
2541
}

0 commit comments

Comments
 (0)