PGPainless/sop-java
1
0
Fork 0
mirror of https://codeberg.org/PGPainless/sop-java.git synced 2024-11-22 23:22:05 +01:00
Code Issues Projects Releases Packages Wiki Activity

Javadoc: Insert <p> tags to preserve newlines

Browse source
This commit is contained in:
Paul Schaub 2023-04-26 16:44:49 +02:00
parent ed59c713eb
commit e336e536a8
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
4 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
sop-java/src/main/java/sop/SOP.java
View file

@ -54,7 +54,7 @@ public interface SOP {
/** /**
* Create detached signatures. * Create detached signatures.
* Customize the operation using the builder {@link DetachedSign}. * Customize the operation using the builder {@link DetachedSign}.
* * <p>
* If you want to sign a message inline, use {@link #inlineSign()} instead. * If you want to sign a message inline, use {@link #inlineSign()} instead.
* *
* @return builder instance * @return builder instance
@ -66,7 +66,7 @@ public interface SOP {
/** /**
* Create detached signatures. * Create detached signatures.
* Customize the operation using the builder {@link DetachedSign}. * Customize the operation using the builder {@link DetachedSign}.
* * <p>
* If you want to sign a message inline, use {@link #inlineSign()} instead. * If you want to sign a message inline, use {@link #inlineSign()} instead.
* *
* @return builder instance * @return builder instance
@ -75,7 +75,7 @@ public interface SOP {
/** /**
* Sign a message using inline signatures. * Sign a message using inline signatures.
* * <p>
* If you need to create detached signatures, use {@link #detachedSign()} instead. * If you need to create detached signatures, use {@link #detachedSign()} instead.
* *
* @return builder instance * @return builder instance
@ -85,7 +85,7 @@ public interface SOP {
/** /**
* Verify detached signatures. * Verify detached signatures.
* Customize the operation using the builder {@link DetachedVerify}. * Customize the operation using the builder {@link DetachedVerify}.
* * <p>
* If you need to verify an inline-signed message, use {@link #inlineVerify()} instead. * If you need to verify an inline-signed message, use {@link #inlineVerify()} instead.
* *
* @return builder instance * @return builder instance
@ -97,7 +97,7 @@ public interface SOP {
/** /**
* Verify detached signatures. * Verify detached signatures.
* Customize the operation using the builder {@link DetachedVerify}. * Customize the operation using the builder {@link DetachedVerify}.
* * <p>
* If you need to verify an inline-signed message, use {@link #inlineVerify()} instead. * If you need to verify an inline-signed message, use {@link #inlineVerify()} instead.
* *
* @return builder instance * @return builder instance
@ -106,7 +106,7 @@ public interface SOP {
/** /**
* Verify signatures of an inline-signed message. * Verify signatures of an inline-signed message.
* * <p>
* If you need to verify detached signatures over a message, use {@link #detachedVerify()} instead. * If you need to verify detached signatures over a message, use {@link #detachedVerify()} instead.
* *
* @return builder instance * @return builder instance

2
sop-java/src/main/java/sop/SigningResult.java
View file

@ -19,7 +19,7 @@ public final class SigningResult {
* Return a string identifying the digest mechanism used to create the signed message. * Return a string identifying the digest mechanism used to create the signed message.
* This is useful for setting the micalg= parameter for the multipart/signed * This is useful for setting the micalg= parameter for the multipart/signed
* content type of a PGP/MIME object as described in section 5 of [RFC3156]. * content type of a PGP/MIME object as described in section 5 of [RFC3156].
* * <p>
* If more than one signature was generated and different digest mechanisms were used, * If more than one signature was generated and different digest mechanisms were used,
* the value of the micalg object is an empty string. * the value of the micalg object is an empty string.
* *

2
sop-java/src/main/java/sop/exception/SOPGPException.java
View file

@ -337,7 +337,7 @@ public abstract class SOPGPException extends RuntimeException {
/** /**
* Exception that gets thrown if a special designator (starting with @) is given, but the filesystem contains * Exception that gets thrown if a special designator (starting with @) is given, but the filesystem contains
* a file matching the designator. * a file matching the designator.
* * <p>
* E.g. <pre>@ENV:FOO</pre> is given, but <pre>./@ENV:FOO</pre> exists on the filesystem. * E.g. <pre>@ENV:FOO</pre> is given, but <pre>./@ENV:FOO</pre> exists on the filesystem.
*/ */
public static class AmbiguousInput extends SOPGPException { public static class AmbiguousInput extends SOPGPException {

2
sop-java/src/main/java/sop/util/ProxyOutputStream.java
View file

@ -12,7 +12,7 @@ import java.io.OutputStream;
* {@link OutputStream} that buffers data being written into it, until its underlying output stream is being replaced. * {@link OutputStream} that buffers data being written into it, until its underlying output stream is being replaced.
* At that point, first all the buffered data is being written to the underlying stream, followed by any successive * At that point, first all the buffered data is being written to the underlying stream, followed by any successive
* data that may get written to the {@link ProxyOutputStream}. * data that may get written to the {@link ProxyOutputStream}.
* * <p>
* This class is useful if we need to provide an {@link OutputStream} at one point in time when the final * This class is useful if we need to provide an {@link OutputStream} at one point in time when the final
* target output stream is not yet known. * target output stream is not yet known.
*/ */