Skip to content

Document Apache HTTP cookie implementations - #527

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-apache-http-impl-cookie
Open

Document Apache HTTP cookie implementations#527
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-apache-http-impl-cookie

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Replaced all 699 placeholder XML documentation entries in Org.Apache.Http.Impl.Cookie.
  • Added namespace, type, member, parameter, return-value, and binding-infrastructure documentation without changing other namespaces.

Closes #271

Sources

Validation

  • Parsed all 34 scoped XML files successfully.
  • Confirmed zero To be added placeholders in the scoped namespace.
  • Confirmed CRLF line endings and a clean git diff --check.

Closes #271

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR replaces placeholder XML documentation in Org.Apache.Http.Impl.Cookie with descriptive namespace/type/member/parameter/return-value docs, aligning the generated API docs with the underlying Apache HTTP cookie implementations.

Changes:

  • Replaced To be added. placeholders across the Org.Apache.Http.Impl.Cookie namespace.
  • Added/updated summaries, parameter docs, return/value docs, and binding-infrastructure (JNI peer/threshold) documentation.
  • Documented cookie policies/specs (RFC 2109, RFC 2965, Netscape draft, browser-compat, best-match) and related handlers/utilities.

Reviewed changes

Copilot reviewed 34 out of 34 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2965VersionAttributeHandler.xml Replaced placeholders with docs for the RFC 2965 Version attribute handler.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2965SpecFactory.xml Documented factory for creating RFC 2965 cookie specs.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2965Spec.xml Documented RFC 2965 cookie parsing/validation/matching/formatting behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2965PortAttributeHandler.xml Documented RFC 2965 Port attribute parsing/validation/matching.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2965DomainAttributeHandler.xml Documented RFC 2965 Domain attribute parsing/validation/matching.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2965DiscardAttributeHandler.xml Documented RFC 2965 Discard attribute handler members.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2965CommentUrlAttributeHandler.xml Documented RFC 2965 CommentURL attribute parsing and application.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2109VersionHandler.xml Documented RFC 2109 Version attribute parsing/validation behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2109SpecFactory.xml Documented factory for creating RFC 2109 cookie specs.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2109Spec.xml Documented RFC 2109 cookie parsing/validation/matching/formatting behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/RFC2109DomainHandler.xml Documented RFC 2109 domain validation/matching rules.
docs/xml/Org.Apache.Http.Impl.Cookie/NetscapeDraftSpecFactory.xml Documented factory for creating Netscape draft cookie specs.
docs/xml/Org.Apache.Http.Impl.Cookie/NetscapeDraftSpec.xml Documented Netscape draft cookie spec parsing/formatting and related members.
docs/xml/Org.Apache.Http.Impl.Cookie/NetscapeDraftHeaderParser.xml Documented Netscape draft header parsing API and default parser instance.
docs/xml/Org.Apache.Http.Impl.Cookie/NetscapeDomainHandler.xml Documented Netscape draft domain validation/matching rules.
docs/xml/Org.Apache.Http.Impl.Cookie/DateUtils.xml Documented cookie date formatting/parsing utilities and supported date patterns.
docs/xml/Org.Apache.Http.Impl.Cookie/DateParseException.xml Documented exception surfaced for unparseable cookie date strings.
docs/xml/Org.Apache.Http.Impl.Cookie/CookieSpecBase.xml Documented shared base behavior for parsing/matching/validating cookie specs.
docs/xml/Org.Apache.Http.Impl.Cookie/BrowserCompatSpecFactory.xml Documented factory for browser-compatible cookie specs.
docs/xml/Org.Apache.Http.Impl.Cookie/BrowserCompatSpec.xml Documented browser-compatible cookie parsing/formatting and date-pattern behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/BestMatchSpecFactory.xml Documented factory for best-match cookie spec selection.
docs/xml/Org.Apache.Http.Impl.Cookie/BestMatchSpec.xml Documented best-match policy selection and cookie parsing/validation behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicSecureHandler.xml Documented Secure attribute parsing/behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicPathHandler.xml Documented Path attribute parsing/validation/matching behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicMaxAgeHandler.xml Documented Max-Age parsing and expiry-date derivation behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicExpiresHandler.xml Documented Expires parsing into a cookie expiry date.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicDomainHandler.xml Documented conventional Domain attribute parsing/validation/matching.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicCommentHandler.xml Documented Comment attribute parsing/behavior.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicClientCookie2.xml Documented RFC 2965 extensions (discard/ports/comment URL) on client cookies.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicClientCookie+InterfaceConsts.xml Documented standard attribute-name constants used by client cookies.
docs/xml/Org.Apache.Http.Impl.Cookie/BasicClientCookie.xml Documented mutable client cookie behavior, attributes, and helpers.
docs/xml/Org.Apache.Http.Impl.Cookie/AbstractCookieSpec.xml Documented base cookie spec dispatch/registration model for attribute handlers.
docs/xml/Org.Apache.Http.Impl.Cookie/AbstractCookieAttributeHandler.xml Documented default behavior for cookie attribute handlers (parse/match/validate).
docs/xml/ns-Org.Apache.Http.Impl.Cookie.xml Documented the namespace purpose and scope.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Org.Apache.Http.Impl.Cookie/DateUtils.xml
Comment thread docs/xml/Org.Apache.Http.Impl.Cookie/RFC2109Spec.xml Outdated
Refs #271

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

1 similar comment
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add XML documentation for Org.Apache.Http.Impl.Cookie

2 participants