Copilot commented on code in PR #13422: URL: https://github.com/apache/trafficserver/pull/13422#discussion_r3638682860
########## include/proxy/hdrs/HTTP.h: ########## @@ -616,10 +630,72 @@ class HTTPHdr : public MIMEHdr void mark_early_data(bool flag = true) const; bool is_early_data() const; + /** + * Parse an HTTP/1.x request header incrementally from a raw buffer. + * + * Parses input data into the header's request fields. Call repeatedly with the same @p parser + * until a result other than @c ParseResult::CONT is returned. When @c ParseResult::DONE is + * returned, the request method, URL, version, and header fields are set on this header. + * + * @param parser Parser state. Must be the same object on each call for a given message. + * @param start [in,out] On entry, points to the first unparsed byte; on return, + * advanced past all consumed bytes. + * @param end One past the last available byte of input. + * @param eof @c true if no more data will follow @p end. + * @param strict_uri_parsing URI compliance level: @c 0 performs no compliance check; @c 1 rejects + * the URI unless every character is a valid RFC 3986 URI character; @c 2 + * is more permissive, rejecting the URI only if it contains whitespace or + * non-printable characters. Other values behave like @c 0. + * @param max_request_line_size Maximum byte length of the request line; exceeding it returns + * @c ParseResult::ERROR. + * @param max_hdr_field_size Maximum byte length of a single header field; exceeding it + * returns @c ParseResult::ERROR. + * Review Comment: Doxygen in this header typically references parameters in prose with `@a <name>` (e.g., the existing `url_string_get` comment uses `@a length`), but this new comment uses `@p parser`/`@p r`. Also, the parameter direction markers are currently embedded in the description (`@param start [in,out] ...`) rather than using Doxygen’s `@param[in,out]` form, which is used elsewhere under `include/proxy/hdrs/` (e.g., `URL.h`, `XPACK.h`). Updating these improves consistency and Doxygen rendering. This issue also appears on line 670 of the same file. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
