search

ArangoDB-Community / arangodb-net-standard

A consistent, comprehensive, minimal interface to enable .NET applications to use the complete range of features exposed by the ArangoDB REST API.
Apache License 2.0
76 stars 30 forks source link

Fix compilation warnings caused by XML doc comments. #435

Closed DiscoPYF closed 1 year ago

DiscoPYF commented 2 years ago

Some XML doc tags <see /> had web links in them, which causes warnings. Web links should just be pasted as is.

Some tags also used to reference a specific method signature but the signature has changed since. I've updated the reference to only use the method name.

DiscoPYF commented 2 years ago

Here is the full list of warnings that were fixed:

1>C:\repos\arangodb-net-standard\arangodb-net-standard\CollectionApi\Models\ComputedValue.cs(25,24,25,29): warning CS1584: XML comment has syntactically incorrect cref attribute 'https://www.arangodb.com/docs/stable/data-modeling-documents-computed-values.html#computed-value-expressions'
1>C:\repos\arangodb-net-standard\arangodb-net-standard\CollectionApi\Models\ComputedValue.cs(25,105,25,105): warning CS1658: Unexpected character '#'. See also error CS1056.
1>C:\repos\arangodb-net-standard\arangodb-net-standard\PregelApi\IPregelApiClient.cs(67,45,67,50): warning CS1584: XML comment has syntactically incorrect cref attribute 'https://www.arangodb.com/docs/stable/http/pregel.html#cancel-pregel-job-execution'
1>C:\repos\arangodb-net-standard\arangodb-net-standard\PregelApi\IPregelApiClient.cs(67,98,67,98): warning CS1658: Unexpected character '#'. See also error CS1056.
1>C:\repos\arangodb-net-standard\arangodb-net-standard\PregelApi\Models\PostStartJobBody.cs(53,24,53,29): warning CS1584: XML comment has syntactically incorrect cref attribute 'https://www.arangodb.com/docs/stable/http/pregel.html#start-pregel-job-execution'
1>C:\repos\arangodb-net-standard\arangodb-net-standard\PregelApi\Models\PostStartJobBody.cs(53,77,53,77): warning CS1658: Unexpected character '#'. See also error CS1056.
1>C:\repos\arangodb-net-standard\arangodb-net-standard\PregelApi\PregelApiClient.cs(140,45,140,50): warning CS1584: XML comment has syntactically incorrect cref attribute 'https://www.arangodb.com/docs/stable/http/pregel.html#cancel-pregel-job-execution'
1>C:\repos\arangodb-net-standard\arangodb-net-standard\PregelApi\PregelApiClient.cs(140,98,140,98): warning CS1658: Unexpected character '#'. See also error CS1056.
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AdminApi\Models\GetLogsQuery.cs(6,35,6,77): warning CS1574: XML comment has cref attribute 'GetLogsAsync(GetLogsQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AdminApi\Models\GetLogsResponse.cs(7,32,7,74): warning CS1574: XML comment has cref attribute 'GetLogsAsync(GetLogsQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AdminApi\Models\GetServerVersionQuery.cs(6,35,6,95): warning CS1574: XML comment has cref attribute 'GetServerVersionAsync(GetServerVersionQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AdminApi\Models\GetServerVersionResponse.cs(6,32,6,92): warning CS1574: XML comment has cref attribute 'GetServerVersionAsync(GetServerVersionQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AnalyzerApi\Models\DeleteAnalyzerResponse.cs(4,34,4,80): warning CS1574: XML comment has cref attribute 'DeleteAnalyzerAsync(string)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AnalyzerApi\Models\GetAnalyzerResponse.cs(6,34,6,77): warning CS1574: XML comment has cref attribute 'GetAnalyzerAsync(string)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\CachedAqlQueryResult.cs(7,34,7,86): warning CS1574: XML comment has cref attribute 'GetCachedAqlQueryResultsAsync()' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\DeleteClearSlowAqlQueriesQuery.cs(5,20,5,103): warning CS1574: XML comment has cref attribute 'DeleteClearSlowAqlQueriesAsync(DeleteClearSlowAqlQueriesQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\DeleteKillRunningAqlQueryQuery.cs(5,20,5,111): warning CS1574: XML comment has cref attribute 'DeleteKillRunningAqlQueryAsync(string, DeleteKillRunningAqlQueryQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\GetCurrentlyRunningAqlQueriesQuery.cs(5,20,5,111): warning CS1574: XML comment has cref attribute 'GetCurrentlyRunningAqlQueriesAsync(GetCurrentlyRunningAqlQueriesQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\GetSlowAqlQueriesQuery.cs(5,20,5,87): warning CS1574: XML comment has cref attribute 'GetSlowAqlQueriesAsync(GetSlowAqlQueriesQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\PostExplainAqlQueryBody.cs(7,20,7,90): warning CS1574: XML comment has cref attribute 'PostExplainAqlQueryAsync(PostExplainAqlQueryBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\PostExplainAqlQueryResponse.cs(6,34,6,104): warning CS1574: XML comment has cref attribute 'PostExplainAqlQueryAsync(PostExplainAqlQueryBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\PostParseAqlQueryBody.cs(5,20,5,86): warning CS1574: XML comment has cref attribute 'PostParseAqlQueryAsync(PostParseAqlQueryBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\PostParseAqlQueryResponse.cs(7,20,7,86): warning CS1574: XML comment has cref attribute 'PostParseAqlQueryAsync(PostParseAqlQueryBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\PutAdjustQueryCacheGlobalPropertiesBody.cs(5,20,5,122): warning CS1574: XML comment has cref attribute 'PutAdjustQueryCacheGlobalPropertiesAsync(PutAdjustQueryCacheGlobalPropertiesBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\PutChangeQueryTrackingConfigurationBody.cs(5,20,5,122): warning CS1574: XML comment has cref attribute 'PutChangeQueryTrackingConfigurationAsync(PutChangeQueryTrackingConfigurationBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\QueryCacheGlobalProperties.cs(6,20,6,77): warning CS1574: XML comment has cref attribute 'GetQueryCacheGlobalPropertiesAsync()' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\QueryTrackingConfiguration.cs(6,20,6,77): warning CS1574: XML comment has cref attribute 'GetQueryTrackingConfigurationAsync()' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\QueryTrackingConfiguration.cs(8,20,8,122): warning CS1574: XML comment has cref attribute 'PutChangeQueryTrackingConfigurationAsync(PutChangeQueryTrackingConfigurationBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\RunningAqlQuery.cs(8,20,8,111): warning CS1574: XML comment has cref attribute 'GetCurrentlyRunningAqlQueriesAsync(GetCurrentlyRunningAqlQueriesQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\AqlFunctionApi\Models\SlowAqlQuery.cs(7,20,7,87): warning CS1574: XML comment has cref attribute 'GetSlowAqlQueriesAsync(GetSlowAqlQueriesQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\BulkOperationsApi\Models\ImportDocumentsQuery.cs(22,114,22,139): warning CS1580: Invalid type for parameter ImportDocumentObjectsBody in XML comment cref attribute: 'BulkOperationsApiClient.PostImportDocumentObjectsAsync(ImportDocumentsQuery, ImportDocumentObjectsBody)'
1>C:\repos\arangodb-net-standard\arangodb-net-standard\BulkOperationsApi\Models\ImportDocumentsQuery.cs(22,37,22,140): warning CS1574: XML comment has cref attribute 'PostImportDocumentObjectsAsync(ImportDocumentsQuery, ImportDocumentObjectsBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\CollectionApi\Models\GetChecksumQuery.cs(8,40,8,103): warning CS1574: XML comment has cref attribute 'GetChecksumAsync(string, GetChecksumQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\CollectionApi\Models\GetChecksumResponse.cs(9,34,9,97): warning CS1574: XML comment has cref attribute 'GetChecksumAsync(string, GetChecksumQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\GraphApi\GraphApiClient.cs(428,20,428,32): warning CS1571: XML comment has a duplicate param tag for 'token'
1>C:\repos\arangodb-net-standard\arangodb-net-standard\GraphApi\IGraphApiClient.cs(58,82,58,87): warning CS1573: Parameter 'token' has no matching param tag in the XML comment for 'IGraphApiClient.GetGraphAsync(string, CancellationToken)' (but other parameters do)
1>C:\repos\arangodb-net-standard\arangodb-net-standard\IndexApi\Models\GetAllCollectionIndexesResponse.cs(8,34,8,107): warning CS1574: XML comment has cref attribute 'GetAllCollectionIndexesAsync(GetAllCollectionIndexesQuery)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\IndexApi\Models\GetIndexResponse.cs(4,34,4,70): warning CS1574: XML comment has cref attribute 'GetIndexAsync(string)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\ViewApi\Models\DeleteViewResponse.cs(4,34,4,72): warning CS1574: XML comment has cref attribute 'DeleteViewAsync(string)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\ViewApi\Models\GetViewPropertiesResponse.cs(6,34,6,79): warning CS1574: XML comment has cref attribute 'GetViewPropertiesAsync(string)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\ViewApi\Models\GetViewResponse.cs(6,34,6,69): warning CS1574: XML comment has cref attribute 'GetViewAsync(string)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\ViewApi\Models\PutRenameViewBody.cs(4,40,4,100): warning CS1574: XML comment has cref attribute 'PutRenameViewAsync(string, PutRenameViewBody)' that could not be resolved
1>C:\repos\arangodb-net-standard\arangodb-net-standard\ViewApi\Models\PutRenameViewResponse.cs(6,34,6,94): warning CS1574: XML comment has cref attribute 'PutRenameViewAsync(string, PutRenameViewBody)' that could not be resolved