Improve clarity of javadoc

corda · Sep 26, 2023 · 0197e29 · 0197e29
1 parent 0f7e2db
commit 0197e29
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/application/src/main/java/net/corda/v5/application/crypto/SigningService.java b/application/src/main/java/net/corda/v5/application/crypto/SigningService.java
@@ -49,7 +49,10 @@ public interface SigningService {
      * primary identity, or previously generated via the freshKey method. If the {@link PublicKey} is actually
      * a {@link CompositeKey}, the first leaf signing key hosted by the node is used.
      * @param signatureSpec The {@link SignatureSpec} to use when producing this signature.
-     * @param context The execution context of the signing operation.
+     * @param context The execution context of the signing operation as a map of strings. Currently accepts the following parameters
+     * <ul>
+     *   <li>category: the type of signing key requested for additional verification</li>
+     * </ul>
      *
      * @return A {@link DigitalSignature.WithKeyId} representing the signed data and the {@link PublicKey} that belongs to the
      * same {@link KeyPair} as the {@link PrivateKey} that signed the data.