SOPV: Document since when operations are available

This commit is contained in:
Paul Schaub 2025-07-25 12:21:06 +02:00
parent d4e8c14b08
commit e680f3450a
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311

View file

@ -12,27 +12,41 @@ import sop.operation.Version
/** Subset of [SOP] implementing only OpenPGP signature verification. */
interface SOPV {
/** Get information about the implementations name and version. */
/**
* Get information about the implementations name and version.
*
* @since sopv 1.0
*/
fun version(): Version?
/**
* Verify detached signatures. If you need to verify an inline-signed message, use
* [inlineVerify] instead.
*
* @since sopv 1.0
*/
fun verify(): DetachedVerify? = detachedVerify()
/**
* Verify detached signatures. If you need to verify an inline-signed message, use
* [inlineVerify] instead.
*
* @since sopv 1.0
*/
fun detachedVerify(): DetachedVerify?
/**
* Verify signatures of an inline-signed message. If you need to verify detached signatures over
* a message, use [detachedVerify] instead.
*
* @since sopv 1.0
*/
fun inlineVerify(): InlineVerify?
/** Validate a UserID in an OpenPGP certificate. */
/**
* Validate a UserID in an OpenPGP certificate.
*
* @since sopv 1.2
*/
fun validateUserId(): ValidateUserId?
}