The public surface is not documented at the level promised by the README and expected by Swift DocC. A static scan found roughly 521 public or open declaration lines without an immediately preceding documentation comment out of 794 public or open declaration lines under Sources/ARCP. Examples include the public Envelope stored properties at Sources/ARCP/Envelope/Envelope.swift:9, most ResultChunkStream APIs at Sources/ARCP/Client/ResultChunkStream.swift:3, public ARCPClient.InvocationResult properties at Sources/ARCP/Client/ARCPClient.swift:371, and public auth and transport methods such as JWTAuthValidator.validate at Sources/ARCP/Auth/JWTAuth.swift:24 and WebSocketClient.connect at Sources/ARCP/Transport/WebSocketTransport.swift:75. Many documented throwing or returning APIs also provide only a summary and do not include Swift-flavored - Parameters:, - Returns:, or - Throws: fields.
Fix prompt: Add DocC-compliant comments to every public and open type, property, initializer, method, enum case, and protocol requirement that is part of the library API. Each comment should start with a clear summary, should use Swift API Design Guidelines terminology, and should include - Parameters:, - Returns:, and - Throws: sections wherever the signature warrants them. Add a documentation lint step or DocC generation warning check so missing public docs do not regress.
The public surface is not documented at the level promised by the README and expected by Swift DocC. A static scan found roughly 521 public or open declaration lines without an immediately preceding documentation comment out of 794 public or open declaration lines under
Sources/ARCP. Examples include the publicEnvelopestored properties atSources/ARCP/Envelope/Envelope.swift:9, mostResultChunkStreamAPIs atSources/ARCP/Client/ResultChunkStream.swift:3, publicARCPClient.InvocationResultproperties atSources/ARCP/Client/ARCPClient.swift:371, and public auth and transport methods such asJWTAuthValidator.validateatSources/ARCP/Auth/JWTAuth.swift:24andWebSocketClient.connectatSources/ARCP/Transport/WebSocketTransport.swift:75. Many documented throwing or returning APIs also provide only a summary and do not include Swift-flavored- Parameters:,- Returns:, or- Throws:fields.Fix prompt: Add DocC-compliant comments to every public and open type, property, initializer, method, enum case, and protocol requirement that is part of the library API. Each comment should start with a clear summary, should use Swift API Design Guidelines terminology, and should include
- Parameters:,- Returns:, and- Throws:sections wherever the signature warrants them. Add a documentation lint step or DocC generation warning check so missing public docs do not regress.