Skip to content

Commit 43cee7b

Browse files
committed
Fixed comments
1 parent 5ae3706 commit 43cee7b

File tree

2 files changed

+30
-6
lines changed

2 files changed

+30
-6
lines changed

arangodb-net-standard/ViewApi/IViewsApiClient.cs

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ Task<GetAllViewsResponse> GetAllViewsAsync(
2525
/// POST /_api/view
2626
/// </summary>
2727
/// <param name="body">The body of the request containing required properties.</param>
28-
/// <param name="ignoreNullValuesOnSerialization">Indicates whether to ignore null values during serialization.</param>
28+
/// <param name="ignoreNullValuesOnSerialization">
29+
/// Indicates whether to ignore null values during serialization.
30+
/// This parameter can be used together with <see cref="LinkProperties.IncludeAllFields"/>
31+
/// set to false to control if fields with null values are included.
32+
/// </param>
2933
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
3034
/// <returns></returns>
3135
Task<ViewResponse> PostCreateViewAsync(ViewDetails body, bool ignoreNullValuesOnSerialization = true, CancellationToken token = default);
@@ -66,7 +70,11 @@ Task<GetViewPropertiesResponse> GetViewPropertiesAsync(string viewNameOrId,
6670
/// </summary>
6771
/// <param name="viewNameOrId">The name or identifier of the view.</param>
6872
/// <param name="body">The body of the request containing required properties.</param>
69-
/// <param name="ignoreNullValuesOnSerialization">Indicates whether to ignore null values during serialization.</param>
73+
/// <param name="ignoreNullValuesOnSerialization">
74+
/// Indicates whether to ignore null values during serialization.
75+
/// This parameter can be used together with <see cref="LinkProperties.IncludeAllFields"/>
76+
/// set to false to control if fields with null values are included.
77+
/// </param>
7078
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
7179
/// <returns></returns>
7280
Task<ViewResponse> PatchViewPropertiesAsync(string viewNameOrId, ViewDetails body, bool ignoreNullValuesOnSerialization = true,
@@ -78,7 +86,11 @@ Task<ViewResponse> PatchViewPropertiesAsync(string viewNameOrId, ViewDetails bod
7886
/// </summary>
7987
/// <param name="viewName">The name of the view.</param>
8088
/// <param name="body">The body of the request containing required properties.</param>
81-
/// <param name="ignoreNullValuesOnSerialization">Indicates whether to ignore null values during serialization.</param>
89+
/// <param name="ignoreNullValuesOnSerialization">
90+
/// Indicates whether to ignore null values during serialization.
91+
/// This parameter can be used together with <see cref="LinkProperties.IncludeAllFields"/>
92+
/// set to false to control if fields with null values are included.
93+
/// </param>
8294
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
8395
/// <returns></returns>
8496
Task<ViewResponse> PutViewPropertiesAsync(string viewName, ViewDetails body, bool ignoreNullValuesOnSerialization = true,

arangodb-net-standard/ViewApi/ViewsApiClient.cs

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,11 @@ public virtual async Task<GetAllViewsResponse> GetAllViewsAsync(
7373
/// POST /_api/view
7474
/// </summary>
7575
/// <param name="body">The body of the request containing required properties.</param>
76-
/// <param name="ignoreNullValuesOnSerialization">Indicates whether to ignore null values during serialization.</param>
76+
/// <param name="ignoreNullValuesOnSerialization">
77+
/// Indicates whether to ignore null values during serialization.
78+
/// This parameter can be used together with <see cref="LinkProperties.IncludeAllFields"/>
79+
/// set to false to control if fields with null values are included.
80+
/// </param>
7781
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
7882
/// <returns></returns>
7983
public virtual async Task<ViewResponse> PostCreateViewAsync(ViewDetails body, bool ignoreNullValuesOnSerialization=true, CancellationToken token = default)
@@ -167,7 +171,11 @@ public virtual async Task<GetViewPropertiesResponse> GetViewPropertiesAsync(stri
167171
/// </summary>
168172
/// <param name="viewNameOrId">The name or identifier of the view.</param>
169173
/// <param name="body">The body of the request containing required properties.</param>
170-
/// <param name="ignoreNullValuesOnSerialization">Indicates whether to ignore null values during serialization.</param>
174+
/// <param name="ignoreNullValuesOnSerialization">
175+
/// Indicates whether to ignore null values during serialization.
176+
/// This parameter can be used together with <see cref="LinkProperties.IncludeAllFields"/>
177+
/// set to false to control if fields with null values are included.
178+
/// </param>
171179
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
172180
/// <returns></returns>
173181
public virtual async Task<ViewResponse> PatchViewPropertiesAsync(string viewNameOrId, ViewDetails body,
@@ -196,7 +204,11 @@ public virtual async Task<ViewResponse> PatchViewPropertiesAsync(string viewName
196204
/// </summary>
197205
/// <param name="viewName">The name of the view.</param>
198206
/// <param name="body">The body of the request containing required properties.</param>
199-
/// <param name="ignoreNullValuesOnSerialization">Indicates whether to ignore null values during serialization.</param>
207+
/// <param name="ignoreNullValuesOnSerialization">
208+
/// Indicates whether to ignore null values during serialization.
209+
/// This parameter can be used together with <see cref="LinkProperties.IncludeAllFields"/>
210+
/// set to false to control if fields with null values are included.
211+
/// </param>
200212
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
201213
/// <returns></returns>
202214
public virtual async Task<ViewResponse> PutViewPropertiesAsync(string viewName, ViewDetails body,

0 commit comments

Comments
 (0)