mirror of
https://codeberg.org/PGPainless/wkd-java.git
synced 2024-12-22 13:47:58 +01:00
Improve javadoc
This commit is contained in:
parent
40d5d6eba6
commit
d0a161e87a
3 changed files with 8 additions and 1 deletions
|
@ -21,7 +21,12 @@ public class WKDAddressHelper {
|
||||||
* The user-id is herein expected to follow the mail name-addr format described in RFC2822.
|
* The user-id is herein expected to follow the mail name-addr format described in RFC2822.
|
||||||
*
|
*
|
||||||
* Example User ID (angle normally not escaped):
|
* Example User ID (angle normally not escaped):
|
||||||
* "Slim Shady <sshady@marshall-mathers.lp> [Yes, the real Shady]"
|
* {@code
|
||||||
|
* <pre>
|
||||||
|
* Slim Shady <sshady@marshall-mathers.lp> [Yes, the real Shady]"
|
||||||
|
* </pre>
|
||||||
|
* }
|
||||||
|
*
|
||||||
*
|
*
|
||||||
* @see <a href="https://datatracker.ietf.org/doc/html/rfc4880#section-5.11">
|
* @see <a href="https://datatracker.ietf.org/doc/html/rfc4880#section-5.11">
|
||||||
* RFC4880 - OpenPGP Message Format - §5.11 User ID Packet</a>
|
* RFC4880 - OpenPGP Message Format - §5.11 User ID Packet</a>
|
||||||
|
|
|
@ -19,6 +19,7 @@ public interface CertificateFetcher {
|
||||||
* Attempt to fetch an OpenPGP certificate from the Web Key Directory.
|
* Attempt to fetch an OpenPGP certificate from the Web Key Directory.
|
||||||
*
|
*
|
||||||
* @param address WKDAddress object
|
* @param address WKDAddress object
|
||||||
|
* @param method discovery method
|
||||||
* @return input stream containing the certificate in its binary representation
|
* @return input stream containing the certificate in its binary representation
|
||||||
*
|
*
|
||||||
* @throws IOException in case of an error
|
* @throws IOException in case of an error
|
||||||
|
|
|
@ -48,6 +48,7 @@ public class DiscoveryResult {
|
||||||
* This method does not close the output stream.
|
* This method does not close the output stream.
|
||||||
*
|
*
|
||||||
* @param outputStream output stream
|
* @param outputStream output stream
|
||||||
|
* @throws IOException in case of an IO error
|
||||||
*/
|
*/
|
||||||
public void write(OutputStream outputStream)
|
public void write(OutputStream outputStream)
|
||||||
throws IOException {
|
throws IOException {
|
||||||
|
|
Loading…
Reference in a new issue