andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix JavaDoc of Http2Headers (#10711)

Browse Source 
Motivation:
Http2Headers has JavaDoc error which says Sets the {@link PseudoHeaderName#AUTHORITY} header or {@code null} if there is no such header however it should be Sets the {@link PseudoHeaderName#AUTHORITY} header in Http2Headers#authority(CharSequence) methods because it only sets CharSequence.

This is true for all setters in Http2Headers.

Modification:
Fixed all JavaDoc errors.

Result:
Better JavaDoc.
This commit is contained in:
Aayush Atharva 2020-10-23 19:05:43 +05:30 committed by GitHub
parent e5951d46fc
commit 6ae7f9e1a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
codec-http2/src/main/java/io/netty/handler/codec/http2/Http2Headers.java
View File

@ -141,22 +141,22 @@ public interface Http2Headers extends Headers<CharSequence, CharSequence, Http2H
Http2Headers method(CharSequence value);
/**
* Sets the {@link PseudoHeaderName#SCHEME} header if there is no such header
* Sets the {@link PseudoHeaderName#SCHEME} header
*/
Http2Headers scheme(CharSequence value);
/**
* Sets the {@link PseudoHeaderName#AUTHORITY} header or {@code null} if there is no such header
* Sets the {@link PseudoHeaderName#AUTHORITY} header
*/
Http2Headers authority(CharSequence value);
/**
* Sets the {@link PseudoHeaderName#PATH} header or {@code null} if there is no such header
* Sets the {@link PseudoHeaderName#PATH} header
*/
Http2Headers path(CharSequence value);
/**
* Sets the {@link PseudoHeaderName#STATUS} header or {@code null} if there is no such header
* Sets the {@link PseudoHeaderName#STATUS} header
*/
Http2Headers status(CharSequence value);