487 lines
14 KiB
Markdown
487 lines
14 KiB
Markdown
# Documentation Analysis Report
|
|
|
|
Files Scanned: 273
|
|
Files With Issues: 36
|
|
Total Issues: 48
|
|
|
|
## Issues
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/ExternalAuthCalloutAuthenticator.cs
|
|
LINE: 12
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: ExternalAuthCalloutAuthenticator(IExternalAuthClient client, TimeSpan timeout)
|
|
MESSAGE: Constructor 'ExternalAuthCalloutAuthenticator(IExternalAuthClient client, TimeSpan timeout)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/ExternalAuthCalloutAuthenticator.cs
|
|
LINE: 18
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Authenticate(ClientAuthContext context)
|
|
MESSAGE: Method 'Authenticate(ClientAuthContext context)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/Jwt/AccountClaims.cs
|
|
LINE: 102
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: MaxStreams
|
|
MESSAGE: Property 'MaxStreams' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/Jwt/AccountClaims.cs
|
|
LINE: 105
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Tier
|
|
MESSAGE: Property 'Tier' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/Jwt/JwtConnectionTypes.cs
|
|
LINE: 18
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Convert(IEnumerable<string>? values)
|
|
MESSAGE: Method 'Convert(IEnumerable<string>? values)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/Jwt/NatsJwt.cs
|
|
LINE: 226
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Algorithm
|
|
MESSAGE: Property 'Algorithm' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/Jwt/NatsJwt.cs
|
|
LINE: 230
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Type
|
|
MESSAGE: Property 'Type' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/JwtAuthenticator.cs
|
|
LINE: 15
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: JwtAuthenticator(string[] trustedKeys, IAccountResolver resolver)
|
|
MESSAGE: Constructor 'JwtAuthenticator(string[] trustedKeys, IAccountResolver resolver)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/JwtAuthenticator.cs
|
|
LINE: 21
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Authenticate(ClientAuthContext context)
|
|
MESSAGE: Method 'Authenticate(ClientAuthContext context)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/NKeyAuthenticator.cs
|
|
LINE: 21
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Authenticate(ClientAuthContext context)
|
|
MESSAGE: Method 'Authenticate(ClientAuthContext context)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/ProxyAuthenticator.cs
|
|
LINE: 5
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Authenticate(ClientAuthContext context)
|
|
MESSAGE: Method 'Authenticate(ClientAuthContext context)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/SimpleUserPasswordAuthenticator.cs
|
|
LINE: 17
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: SimpleUserPasswordAuthenticator(string username, string password)
|
|
MESSAGE: Constructor 'SimpleUserPasswordAuthenticator(string username, string password)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/SimpleUserPasswordAuthenticator.cs
|
|
LINE: 23
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Authenticate(ClientAuthContext context)
|
|
MESSAGE: Method 'Authenticate(ClientAuthContext context)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/TokenAuthenticator.cs
|
|
LINE: 10
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: TokenAuthenticator(string token)
|
|
MESSAGE: Constructor 'TokenAuthenticator(string token)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/TokenAuthenticator.cs
|
|
LINE: 15
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Authenticate(ClientAuthContext context)
|
|
MESSAGE: Method 'Authenticate(ClientAuthContext context)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/UserPasswordAuthenticator.cs
|
|
LINE: 16
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: UserPasswordAuthenticator(IEnumerable<User> users)
|
|
MESSAGE: Constructor 'UserPasswordAuthenticator(IEnumerable<User> users)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Auth/UserPasswordAuthenticator.cs
|
|
LINE: 23
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Authenticate(ClientAuthContext context)
|
|
MESSAGE: Method 'Authenticate(ClientAuthContext context)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/ClientClosedReason.cs
|
|
LINE: 31
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: ToReasonString(ClientClosedReason reason)
|
|
MESSAGE: Method 'ToReasonString(ClientClosedReason reason)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/ClientKind.cs
|
|
LINE: 20
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: IsInternal(ClientKind kind)
|
|
MESSAGE: Method 'IsInternal(ClientKind kind)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Configuration/NatsConfLexer.cs
|
|
LINE: 66
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Tokenize(string input)
|
|
MESSAGE: Method 'Tokenize(string input)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Imports/ServiceLatency.cs
|
|
LINE: 5
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: SamplingPercentage
|
|
MESSAGE: Property 'SamplingPercentage' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Imports/ServiceLatency.cs
|
|
LINE: 6
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Subject
|
|
MESSAGE: Property 'Subject' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Imports/StreamExport.cs
|
|
LINE: 5
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Auth
|
|
MESSAGE: Property 'Auth' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/IO/AdaptiveReadBuffer.cs
|
|
LINE: 14
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: CurrentSize
|
|
MESSAGE: Property 'CurrentSize' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/IO/AdaptiveReadBuffer.cs
|
|
LINE: 19
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: RecordRead(int bytesRead)
|
|
MESSAGE: Method 'RecordRead(int bytesRead)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Api/Handlers/AccountApiHandlers.cs
|
|
LINE: 5
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: HandleInfo(StreamManager streams, ConsumerManager consumers)
|
|
MESSAGE: Method 'HandleInfo(StreamManager streams, ConsumerManager consumers)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Api/Handlers/DirectApiHandlers.cs
|
|
LINE: 10
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: HandleGet(string subject, ReadOnlySpan<byte> payload, StreamManager streamManager)
|
|
MESSAGE: Method 'HandleGet(string subject, ReadOnlySpan<byte> payload, StreamManager streamManager)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Api/JetStreamApiError.cs
|
|
LINE: 5
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Code
|
|
MESSAGE: Property 'Code' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Api/JetStreamApiError.cs
|
|
LINE: 6
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Property
|
|
SIGNATURE: Description
|
|
MESSAGE: Property 'Description' is missing XML documentation
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Cluster/AssetPlacementPlanner.cs
|
|
LINE: 7
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: AssetPlacementPlanner(int nodes)
|
|
MESSAGE: Constructor 'AssetPlacementPlanner(int nodes)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Cluster/AssetPlacementPlanner.cs
|
|
LINE: 12
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: PlanReplicas(int replicas)
|
|
MESSAGE: Method 'PlanReplicas(int replicas)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Cluster/MetaSnapshotCodec.cs
|
|
LINE: 28
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Encode(Dictionary<string, StreamAssignment> assignments)
|
|
MESSAGE: Method 'Encode(Dictionary<string, StreamAssignment> assignments)' is missing <param name="assignments"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Cluster/MetaSnapshotCodec.cs
|
|
LINE: 46
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: Decode(byte[] data)
|
|
MESSAGE: Method 'Decode(byte[] data)' is missing <param name="data"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Consumers/DeliveryInterestTracker.cs
|
|
LINE: 15
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: DeliveryInterestTracker(TimeSpan? inactiveTimeout)
|
|
MESSAGE: Constructor 'DeliveryInterestTracker(TimeSpan? inactiveTimeout)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/JetStream/Storage/FileStore.cs
|
|
LINE: 2880
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: EvictBlockNoSync(int blockId)
|
|
MESSAGE: Method 'EvictBlockNoSync(int blockId)' is missing <param name="blockId"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Monitoring/ConnzHandler.cs
|
|
LINE: 13
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: HandleConnz(HttpContext ctx)
|
|
MESSAGE: Method 'HandleConnz(HttpContext ctx)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Monitoring/SubszHandler.cs
|
|
LINE: 12
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: HandleSubsz(HttpContext ctx)
|
|
MESSAGE: Method 'HandleSubsz(HttpContext ctx)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Mqtt/MqttStreamInitializer.cs
|
|
LINE: 21
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Constructor
|
|
SIGNATURE: MqttStreamInitializer(StreamManager streamManager)
|
|
MESSAGE: Constructor 'MqttStreamInitializer(StreamManager streamManager)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Protocol/ClientCommandMatrix.cs
|
|
LINE: 5
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: IsAllowed(global::NATS.Server.ClientKind kind, string? op)
|
|
MESSAGE: Method 'IsAllowed(global::NATS.Server.ClientKind kind, string? op)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Raft/RaftMembership.cs
|
|
LINE: 30
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: TryParse(string command)
|
|
MESSAGE: Method 'TryParse(string command)' is missing <param name="command"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Raft/RaftSnapshotCheckpoint.cs
|
|
LINE: 34
|
|
CATEGORY: MissingParam
|
|
SEVERITY: Warning
|
|
MEMBER: Method
|
|
SIGNATURE: AddChunk(byte[] chunk)
|
|
MESSAGE: Method 'AddChunk(byte[] chunk)' is missing <param name="chunk"> documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Raft/RaftStateExtensions.cs
|
|
LINE: 9
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: String(RaftState state)
|
|
MESSAGE: Method 'String(RaftState state)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Raft/SnapshotChunkEnumerator.cs
|
|
LINE: 89
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: GetEnumerator()
|
|
MESSAGE: Method 'GetEnumerator()' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Subscriptions/RemoteSubscription.cs
|
|
LINE: 11
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Removal(string subject, string? queue, string routeId, string account)
|
|
MESSAGE: Method 'Removal(string subject, string? queue, string routeId, string account)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Subscriptions/RoutedSubKey.cs
|
|
LINE: 5
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: FromRemoteSubscription(RemoteSubscription sub)
|
|
MESSAGE: Method 'FromRemoteSubscription(RemoteSubscription sub)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/Tls/TlsConnectionWrapper.cs
|
|
LINE: 15
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: NegotiateAsync(Socket socket, Stream networkStream, NatsOptions options, SslServerAuthenticationOptions? sslOptions, ServerInfo serverInfo, ILogger logger, CancellationToken ct)
|
|
MESSAGE: Method 'NegotiateAsync(Socket socket, Stream networkStream, NatsOptions options, SslServerAuthenticationOptions? sslOptions, ServerInfo serverInfo, ILogger logger, CancellationToken ct)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/WebSocket/WebSocketOptionsValidator.cs
|
|
LINE: 18
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: Validate(NatsOptions options)
|
|
MESSAGE: Method 'Validate(NatsOptions options)' is missing XML documentation.
|
|
|
|
---
|
|
|
|
FILE: /Users/dohertj2/Desktop/natsdotnet/src/NATS.Server/WebSocket/WsConstants.cs
|
|
LINE: 64
|
|
CATEGORY: MissingDoc
|
|
SEVERITY: Error
|
|
MEMBER: Method
|
|
SIGNATURE: IsControlFrame(int opcode)
|
|
MESSAGE: Method 'IsControlFrame(int opcode)' is missing XML documentation.
|
|
|