Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix compilation warnings caused by XML doc comments. #435

Merged
merged 1 commit into from
Nov 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion arangodb-net-standard/AdminApi/Models/GetLogsQuery.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ArangoDBNetStandard.AdminApi.Models
{
/// <summary>
/// Parameters for <see cref="IAdminApiClient.GetLogsAsync(GetLogsQuery)"/>
/// Parameters for <see cref="IAdminApiClient.GetLogsAsync"/>
/// </summary>
public class GetLogsQuery
{
Expand Down
2 changes: 1 addition & 1 deletion arangodb-net-standard/AdminApi/Models/GetLogsResponse.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace ArangoDBNetStandard.AdminApi.Models
{
/// <summary>
/// Returned by <see cref="IAdminApiClient.GetLogsAsync(GetLogsQuery)"/>
/// Returned by <see cref="IAdminApiClient.GetLogsAsync"/>
/// </summary>
public class GetLogsResponse
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ArangoDBNetStandard.AdminApi.Models
{
/// <summary>
/// Parameters for <see cref="IAdminApiClient.GetServerVersionAsync(GetServerVersionQuery)"/>
/// Parameters for <see cref="IAdminApiClient.GetServerVersionAsync"/>
/// </summary>
public class GetServerVersionQuery
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ArangoDBNetStandard.AdminApi.Models
{
/// <summary>
/// Returned by <see cref="IAdminApiClient.GetServerVersionAsync(GetServerVersionQuery)"/>
/// Returned by <see cref="IAdminApiClient.GetServerVersionAsync"/>
/// </summary>
public class GetServerVersionResponse
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace ArangoDBNetStandard.AnalyzerApi.Models
{
/// <summary>
/// Response from <see cref="IAnalyzerApiClient.DeleteAnalyzerAsync(string)"/>
/// Response from <see cref="IAnalyzerApiClient.DeleteAnalyzerAsync"/>
/// </summary>
public class DeleteAnalyzerResponse : ResponseBase
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ArangoDBNetStandard.AnalyzerApi.Models
{
/// <summary>
/// Response from <see cref="IAnalyzerApiClient.GetAnalyzerAsync(string)"/>
/// Response from <see cref="IAnalyzerApiClient.GetAnalyzerAsync"/>
/// </summary>
public class GetAnalyzerResponse : Analyzer
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace ArangoDBNetStandard.AqlFunctionApi.Models
{
/// <summary>
/// Response from <see cref="AqlFunctionApiClient.GetCachedAqlQueryResultsAsync()"/>
/// Response from <see cref="AqlFunctionApiClient.GetCachedAqlQueryResultsAsync"/>
/// Represents a cached AQL query result.
/// </summary>
public class CachedAqlQueryResult
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
/// <summary>
/// Generates query string for
/// <see cref="AqlFunctionApiClient.DeleteClearSlowAqlQueriesAsync(DeleteClearSlowAqlQueriesQuery)"/>
/// <see cref="AqlFunctionApiClient.DeleteClearSlowAqlQueriesAsync"/>
/// </summary>
public class DeleteClearSlowAqlQueriesQuery
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
/// <summary>
/// Generates query string for
/// <see cref="AqlFunctionApiClient.DeleteKillRunningAqlQueryAsync(string, DeleteKillRunningAqlQueryQuery)"/>
/// <see cref="AqlFunctionApiClient.DeleteKillRunningAqlQueryAsync"/>
/// </summary>
public class DeleteKillRunningAqlQueryQuery
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
/// <summary>
/// Generates query string for
/// <see cref="AqlFunctionApiClient.GetCurrentlyRunningAqlQueriesAsync(GetCurrentlyRunningAqlQueriesQuery)"/>
/// <see cref="AqlFunctionApiClient.GetCurrentlyRunningAqlQueriesAsync"/>
/// </summary>
public class GetCurrentlyRunningAqlQueriesQuery
{
Expand All @@ -26,5 +26,5 @@ internal string ToQueryString()
return "";
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
/// <summary>
/// Generates query string for
/// <see cref="AqlFunctionApiClient.GetSlowAqlQueriesAsync(GetSlowAqlQueriesQuery)"/>
/// <see cref="AqlFunctionApiClient.GetSlowAqlQueriesAsync"/>
/// </summary>
public class GetSlowAqlQueriesQuery
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace ArangoDBNetStandard.AqlFunctionApi.Models
{
/// <summary>
/// Request body for
/// <see cref="AqlFunctionApiClient.PostExplainAqlQueryAsync(PostExplainAqlQueryBody)"/>
/// <see cref="AqlFunctionApiClient.PostExplainAqlQueryAsync"/>
/// </summary>
public class PostExplainAqlQueryBody
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ArangoDBNetStandard.AqlFunctionApi.Models
{
/// <summary>
/// Response from <see cref="AqlFunctionApiClient.PostExplainAqlQueryAsync(PostExplainAqlQueryBody)"/>
/// Response from <see cref="AqlFunctionApiClient.PostExplainAqlQueryAsync"/>
/// See https://www.arangodb.com/docs/stable/http/aql-query.html#explain-an-aql-query
/// </summary>
public class PostExplainAqlQueryResponse:ResponseBase
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
/// <summary>
/// Request body for
/// <see cref="AqlFunctionApiClient.PostParseAqlQueryAsync(PostParseAqlQueryBody) "/>
/// <see cref="AqlFunctionApiClient.PostParseAqlQueryAsync"/>
/// </summary>
public class PostParseAqlQueryBody
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace ArangoDBNetStandard.AqlFunctionApi.Models
{
/// <summary>
/// Response from
/// <see cref="AqlFunctionApiClient.PostParseAqlQueryAsync(PostParseAqlQueryBody)"/>
/// <see cref="AqlFunctionApiClient.PostParseAqlQueryAsync"/>
/// </summary>
public class PostParseAqlQueryResponse : ResponseBase
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
/// <summary>
/// Parameter to
/// <see cref="AqlFunctionApiClient.PutAdjustQueryCacheGlobalPropertiesAsync(PutAdjustQueryCacheGlobalPropertiesBody)"/>
/// <see cref="AqlFunctionApiClient.PutAdjustQueryCacheGlobalPropertiesAsync"/>
/// </summary>
public class PutAdjustQueryCacheGlobalPropertiesBody
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
/// <summary>
/// Parameter to
/// <see cref="AqlFunctionApiClient.PutChangeQueryTrackingConfigurationAsync(PutChangeQueryTrackingConfigurationBody)"/>
/// <see cref="AqlFunctionApiClient.PutChangeQueryTrackingConfigurationAsync"/>
/// </summary>
public class PutChangeQueryTrackingConfigurationBody
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
/// <summary>
/// Represents the global properties of the AQL Query Cache
/// Response from
/// <see cref="AqlFunctionApiClient.GetQueryCacheGlobalPropertiesAsync()"/>
/// <see cref="AqlFunctionApiClient.GetQueryCacheGlobalPropertiesAsync"/>
/// </summary>
public class QueryCacheGlobalProperties
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
/// <summary>
/// Represents the global properties of the AQL Query Cache
/// Returned by
/// <see cref="AqlFunctionApiClient.GetQueryTrackingConfigurationAsync()"/>
/// <see cref="AqlFunctionApiClient.GetQueryTrackingConfigurationAsync"/>
/// and
/// <see cref="AqlFunctionApiClient.PutChangeQueryTrackingConfigurationAsync(PutChangeQueryTrackingConfigurationBody)"/>
/// <see cref="AqlFunctionApiClient.PutChangeQueryTrackingConfigurationAsync"/>
/// </summary>
public class QueryTrackingConfiguration : ResponseBase
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace ArangoDBNetStandard.AqlFunctionApi.Models
{
/// <summary>
/// Response from
/// <see cref="AqlFunctionApiClient.GetCurrentlyRunningAqlQueriesAsync(GetCurrentlyRunningAqlQueriesQuery)"/>
/// <see cref="AqlFunctionApiClient.GetCurrentlyRunningAqlQueriesAsync"/>
/// </summary>
public class RunningAqlQuery
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace ArangoDBNetStandard.AqlFunctionApi.Models
{
/// <summary>
/// Response from
/// <see cref="AqlFunctionApiClient.GetSlowAqlQueriesAsync(GetSlowAqlQueriesQuery)"/>
/// <see cref="AqlFunctionApiClient.GetSlowAqlQueriesAsync"/>
/// Represents an AQL query that are finished
/// and have exceeded the slow query threshold
/// in the selected database.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class ImportDocumentsQuery
public string Collection { get; set; }

/// <summary>
/// Required for <see cref="BulkOperationsApiClient.PostImportDocumentObjectsAsync(ImportDocumentsQuery, ImportDocumentObjectsBody)"/>
/// Required for <see cref="BulkOperationsApiClient.PostImportDocumentObjectsAsync"/>
/// Determines how the body of the request will be interpreted.
/// Type can have the following values:
/// 1) documents: When this type is used, each line in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class ComputedValue
/// <summary>
/// Required. An AQL RETURN operation with an
/// expression that computes the desired value.
/// <see cref="https://www.arangodb.com/docs/stable/data-modeling-documents-computed-values.html#computed-value-expressions"/>
/// https://www.arangodb.com/docs/stable/data-modeling-documents-computed-values.html#computed-value-expressions
/// </summary>
public string Expression { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace ArangoDBNetStandard.CollectionApi.Models
{
/// <summary>
/// Generates query for <see cref="ICollectionApiClient.GetChecksumAsync(string, GetChecksumQuery)"/>
/// Generates query for <see cref="ICollectionApiClient.GetChecksumAsync"/>
/// </summary>
public class GetChecksumQuery
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
namespace ArangoDBNetStandard.CollectionApi.Models
{
/// <summary>
/// Response from <see cref="ICollectionApiClient.GetChecksumAsync(string, GetChecksumQuery)"/>
/// Response from <see cref="ICollectionApiClient.GetChecksumAsync"/>
/// </summary>
public class GetChecksumResponse:ResponseBase
{
Expand Down
1 change: 0 additions & 1 deletion arangodb-net-standard/GraphApi/GraphApiClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,6 @@ public virtual async Task<PostEdgeResponse<T>> PostEdgeAsync<T>(
/// <param name="collectionName">The name of the edge collection the edge belongs to.</param>
/// <param name="edgeKey">The _key attribute of the edge.</param>
/// <param name="query"></param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
/// <param name="headers">Headers to use for this operation.</param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
/// <returns></returns>
Expand Down
1 change: 1 addition & 0 deletions arangodb-net-standard/GraphApi/IGraphApiClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Task<DeleteGraphResponse> DeleteGraphAsync(
/// GET /_api/gharial/{graph}
/// </summary>
/// <param name="graphName"></param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
/// <returns></returns>
Task<GetGraphResponse> GetGraphAsync(string graphName, CancellationToken token = default);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace ArangoDBNetStandard.IndexApi.Models
{
/// <summary>
/// Response from <see cref="IndexApiClient.GetAllCollectionIndexesAsync(GetAllCollectionIndexesQuery)"/>
/// Response from <see cref="IndexApiClient.GetAllCollectionIndexesAsync"/>
/// </summary>
public class GetAllCollectionIndexesResponse : ResponseBase
{
Expand Down
2 changes: 1 addition & 1 deletion arangodb-net-standard/IndexApi/Models/GetIndexResponse.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace ArangoDBNetStandard.IndexApi.Models
{
/// <summary>
/// Response from <see cref="IndexApiClient.GetIndexAsync(string)"/>
/// Response from <see cref="IndexApiClient.GetIndexAsync"/>
/// </summary>
public class GetIndexResponse : IndexResponseBase
{
Expand Down
2 changes: 1 addition & 1 deletion arangodb-net-standard/PregelApi/IPregelApiClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Task<List<PregelJobStatus>> GetAllRunningJobsAsync(
/// discard any intermediate results. This will immediately
/// free all memory taken up by the execution, and will
/// make you lose all intermediary data.
/// For more information <see cref="https://www.arangodb.com/docs/stable/http/pregel.html#cancel-pregel-job-execution"/>
/// For more information see https://www.arangodb.com/docs/stable/http/pregel.html#cancel-pregel-job-execution
/// </remarks>
/// <param name="jobId">The ID of the job.</param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
Expand Down
2 changes: 1 addition & 1 deletion arangodb-net-standard/PregelApi/Models/PostStartJobBody.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public class PostStartJobBody
/// General as well as algorithm-specific options.
/// </summary>
/// <remarks>
/// <see cref="https://www.arangodb.com/docs/stable/http/pregel.html#start-pregel-job-execution"/>
/// https://www.arangodb.com/docs/stable/http/pregel.html#start-pregel-job-execution
/// </remarks>
public Dictionary<string,object> Params { get; set; }
}
Expand Down
2 changes: 1 addition & 1 deletion arangodb-net-standard/PregelApi/PregelApiClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ public virtual async Task<List<PregelJobStatus>> GetAllRunningJobsAsync(Cancella
/// discard any intermediate results. This will immediately
/// free all memory taken up by the execution, and will
/// make you lose all intermediary data.
/// For more information <see cref="https://www.arangodb.com/docs/stable/http/pregel.html#cancel-pregel-job-execution"/>
/// For more information see https://www.arangodb.com/docs/stable/http/pregel.html#cancel-pregel-job-execution
/// </remarks>
/// <param name="jobId">The ID of the job.</param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
Expand Down
2 changes: 1 addition & 1 deletion arangodb-net-standard/ViewApi/Models/DeleteViewResponse.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace ArangoDBNetStandard.ViewApi.Models
{
/// <summary>
/// Response from <see cref="IViewApiClient.DeleteViewAsync(string)"/>
/// Response from <see cref="IViewApiClient.DeleteViewAsync"/>
/// </summary>
public class DeleteViewResponse :ResponseBase
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ArangoDBNetStandard.ViewApi.Models
{
/// <summary>
/// Response from <see cref="IViewApiClient.GetViewPropertiesAsync(string)"/>
/// Response from <see cref="IViewApiClient.GetViewPropertiesAsync"/>
/// </summary>
public class GetViewPropertiesResponse : ViewResponse
{
Expand Down
2 changes: 1 addition & 1 deletion arangodb-net-standard/ViewApi/Models/GetViewResponse.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ArangoDBNetStandard.ViewApi.Models
{
/// <summary>
/// Response from <see cref="IViewApiClient.GetViewAsync(string)"/>
/// Response from <see cref="IViewApiClient.GetViewAsync"/>
/// </summary>
public class GetViewResponse : ViewSummary
{
Expand Down
2 changes: 1 addition & 1 deletion arangodb-net-standard/ViewApi/Models/PutRenameViewBody.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace ArangoDBNetStandard.ViewApi.Models
{
/// <summary>
/// Body parameters for <see cref="IViewApiClient.PutRenameViewAsync(string, PutRenameViewBody)"/>
/// Body parameters for <see cref="IViewApiClient.PutRenameViewAsync"/>
/// </summary>
public class PutRenameViewBody
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace ArangoDBNetStandard.ViewApi.Models
{
/// <summary>
/// Response from <see cref="IViewApiClient.PutRenameViewAsync(string, PutRenameViewBody)"/>
/// Response from <see cref="IViewApiClient.PutRenameViewAsync"/>
/// </summary>
public class PutRenameViewResponse : ViewSummary
{
Expand Down