Document Apache HTTP SSL APIs - #622
Conversation
Refs #304 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the generated XML documentation for the Org.Apache.Http.Conn.Ssl namespace to replace placeholder docs with source-backed descriptions and to align attribution with Apache HttpComponents / Apache License 2.0.
Changes:
- Replaced
To be addedplaceholders with summaries/params/returns for key SSL/hostname-verification APIs. - Updated attribution text to reference the Apache Software Foundation and Apache License 2.0.
- Added brief documentation for several binding infrastructure members (e.g.,
JniPeerMembers).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/xml/Org.Apache.Http.Conn.Ssl/StrictHostnameVerifier.xml | Fills in missing member documentation and updates attribution text. |
| docs/xml/Org.Apache.Http.Conn.Ssl/SSLSocketFactory.xml | Documents constructor parameters/returns, updates attribution text. |
| docs/xml/Org.Apache.Http.Conn.Ssl/IX509HostnameVerifier.xml | Adds missing parameter/return documentation and updates attribution text. |
| docs/xml/Org.Apache.Http.Conn.Ssl/BrowserCompatHostnameVerifier.xml | Adds missing method/return documentation and updates attribution text. |
| docs/xml/Org.Apache.Http.Conn.Ssl/AllowAllHostnameVerifier.xml | Adds missing method/return documentation and updates attribution text. |
| docs/xml/Org.Apache.Http.Conn.Ssl/AbstractVerifier.xml | Adds missing helper/method documentation and updates attribution text. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Refs #304 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
ConnectSocketAsync is newly documented as returning an unconnected SSL socket, but it wraps ConnectSocket, which connects and verifies the socket before returning it. This also contradicts the accepted scope of leaving generated *Async wrappers undocumented. Please restore this wrapper's return documentation to To be added.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: ff589cbb-0c3b-4ee8-a6ab-d2e433dde117
|
Addressed the requested change in 6bf9e33: restored \ConnectSocketAsync's generated <returns>To be added.\ documentation without changing the documented synchronous API scope. The six changed XML files pass XML/ECMA structure validation, CRLF validation, and \git diff --check. |
dalexsoto
left a comment
There was a problem hiding this comment.
The SSL contracts now match the Apache implementation, and the generated async-wrapper scope is consistently preserved.
Summary
Org.Apache.Http.Conn.Ssl.*Asyncbinding wrappers undocumented because no authoritative Android or published binding source describes their behavior.Refs #304
Sources
org.apache.http.conn.sslValidation
git diff --check.docs/xml/Org.Apache.Http.Conn.Ssl.To be addedcount: 73 before, 16 after; the remaining placeholders are the unsupported generated*Asyncwrappers.