removed ignore doclint for java 8. Resolved javadoc issues.

This commit is contained in:
Micah Silverman 2017-10-10 15:30:48 -04:00
parent 6541030161
commit 5d709bee80
4 changed files with 8 additions and 13 deletions

4
.gitignore vendored
View File

@ -20,3 +20,7 @@ target/
.classpath
.project
.settings
.clover
.java-version

10
pom.xml
View File

@ -404,16 +404,6 @@
</plugins>
</build>
<profiles>
<profile>
<id>jdk8</id>
<activation>
<jdk>1.8</jdk>
</activation>
<properties>
<!-- Turn off JDK 8's lint checks: -->
<additionalparam>-Xdoclint:none</additionalparam>
</properties>
</profile>
<profile>
<id>sign</id>
<build>

View File

@ -113,7 +113,7 @@ public interface Header<T extends Header<T>> extends Map<String,Object> {
* Returns the JWT <a href="https://tools.ietf.org/html/rfc7516#section-4.1.3"><code>zip</code></a>
* (Compression Algorithm) header parameter value or {@code null} if not present.
*
* <h5>Compatiblity Note</h5>
* <h3>Compatiblity Note</h3>
*
* <p>While the JWT family of specifications only defines the <code>zip</code> header in the JWE
* (JSON Web Encryption) specification, JJWT will also support compression for JWS as well if you choose to use it.
@ -135,7 +135,7 @@ public interface Header<T extends Header<T>> extends Map<String,Object> {
* and must be used carefully since, is not expected that other libraries (including previous versions of this one)
* be able to deserialize a compressed JTW body correctly. </p>
*
* <h5>Compatiblity Note</h5>
* <h3>Compatiblity Note</h3>
*
* <p>While the JWT family of specifications only defines the <code>zip</code> header in the JWE
* (JSON Web Encryption) specification, JJWT will also support compression for JWS as well if you choose to use it.

View File

@ -18,10 +18,11 @@ public interface SerializationCodec {
/**
* Deserialize a {@code byte[]} to an {@code object} of an specific {@code type}
*
* <pre>
* bytes[] serialized = ...
* Map instance = serializationCodec.deserialize(serialized, Map.class);
* <pre>
* </pre>
*
* @param bytes of the serialized object.
* @param targetClass of the instance to return.