chore: javadoc fixes (format)
Signed-off-by: Leo Galambos <lg@hq.egothor.org>
This commit is contained in:
@@ -59,12 +59,7 @@ public final class Strings {
|
|||||||
* truncated after 32 elements, followed by an ellipsis marker: {@code [...]}.
|
* truncated after 32 elements, followed by an ellipsis marker: {@code [...]}.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* <p>
|
* <h4>Examples</h4> <pre>{@code
|
||||||
* Examples:
|
|
||||||
* </p>
|
|
||||||
*
|
|
||||||
* <pre>
|
|
||||||
* {@code
|
|
||||||
* Strings.toShortString(null) -> "null"
|
* Strings.toShortString(null) -> "null"
|
||||||
* Strings.toShortString(new byte[0]) -> "[]"
|
* Strings.toShortString(new byte[0]) -> "[]"
|
||||||
* Strings.toShortString(new byte[]{1, 2, 3})
|
* Strings.toShortString(new byte[]{1, 2, 3})
|
||||||
@@ -118,7 +113,7 @@ public final class Strings {
|
|||||||
* <li>If {@code a} is empty, the string {@code "[]"} is returned.</li>
|
* <li>If {@code a} is empty, the string {@code "[]"} is returned.</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Examples</h2> <pre>{@code
|
* <h4>Examples</h4> <pre>{@code
|
||||||
* toShortHexString(null) -> "null"
|
* toShortHexString(null) -> "null"
|
||||||
* toShortHexString(new byte[0]) -> "[]"
|
* toShortHexString(new byte[0]) -> "[]"
|
||||||
* toShortHexString(new byte[]{0x01}) -> "[0x01]"
|
* toShortHexString(new byte[]{0x01}) -> "[0x01]"
|
||||||
|
|||||||
@@ -78,7 +78,7 @@ public final class PasswordRecipient implements Recipient {
|
|||||||
* marked as a decoy to obscure the actual number of usable recipients.
|
* marked as a decoy to obscure the actual number of usable recipients.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* <h2>Security considerations</h2>
|
* <h4>Security considerations</h4>
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>The caller should clear the {@code password} array after constructing the
|
* <li>The caller should clear the {@code password} array after constructing the
|
||||||
* recipient to minimize exposure in memory.</li>
|
* recipient to minimize exposure in memory.</li>
|
||||||
|
|||||||
@@ -48,10 +48,7 @@ import java.security.GeneralSecurityException;
|
|||||||
* envelope writes the identifier and a length-prefixed copy of the blob into
|
* envelope writes the identifier and a length-prefixed copy of the blob into
|
||||||
* its header.
|
* its header.
|
||||||
*
|
*
|
||||||
* <p>
|
* <h2>Typical usage</h2> <pre>{@code
|
||||||
* Typical usage:
|
|
||||||
* </p>
|
|
||||||
* <pre>{@code
|
|
||||||
* // RSA-OAEP recipient; the header will contain the id and the RSA-wrapped CEK
|
* // RSA-OAEP recipient; the header will contain the id and the RSA-wrapped CEK
|
||||||
* Recipient r = new MultiRecipientDataSourceBuilder.RsaOaepRecipient(rsaPublicKey);
|
* Recipient r = new MultiRecipientDataSourceBuilder.RsaOaepRecipient(rsaPublicKey);
|
||||||
* byte[] entryBlob = r.buildRecipientEntry(cek);
|
* byte[] entryBlob = r.buildRecipientEntry(cek);
|
||||||
@@ -67,7 +64,7 @@ public interface Recipient {
|
|||||||
* intentionally unusable for recovering the content-encryption key (CEK).
|
* intentionally unusable for recovering the content-encryption key (CEK).
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* <h2>Security considerations</h2>
|
* <h4>Security considerations</h4>
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>Decoys prevent traffic analysis from revealing how many legitimate
|
* <li>Decoys prevent traffic analysis from revealing how many legitimate
|
||||||
* recipients are present.</li>
|
* recipients are present.</li>
|
||||||
|
|||||||
Reference in New Issue
Block a user