From 5cf5e430768c7aa6185524a4515971862489cc6a Mon Sep 17 00:00:00 2001
From: Steve Phelps <sphelps@sphelps.net>
Date: Wed, 7 Dec 2022 10:23:03 +0000
Subject: [PATCH] scaladoc

---
 .../SlackSignatureVerifyAction.scala                 | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/main/scala/com/mesonomics/playhmacsignatures/SlackSignatureVerifyAction.scala b/src/main/scala/com/mesonomics/playhmacsignatures/SlackSignatureVerifyAction.scala
index a36d700..edb00af 100644
--- a/src/main/scala/com/mesonomics/playhmacsignatures/SlackSignatureVerifyAction.scala
+++ b/src/main/scala/com/mesonomics/playhmacsignatures/SlackSignatureVerifyAction.scala
@@ -12,6 +12,18 @@ import play.api.mvc.BodyParsers
 import javax.xml.bind.DatatypeConverter
 import scala.concurrent.ExecutionContext
 
+/** This class can be used to validate signatures in
+  * [[https://api.slack.com/authentication/verifying-requests-from-slack#verifying-requests-from-slack-using-signing-secrets__a-recipe-for-security__step-by-step-walk-through-for-validating-a-request Slack requests]].
+  *
+  * @param parser
+  *   The body parser
+  * @param config
+  *   The play configuration instance
+  * @param signatureVerifierService
+  *   The service used to validate the signature against the body
+  * @param ec
+  *   The execution context
+  */
 class SlackSignatureVerifyAction @Inject() (
     parser: BodyParsers.Default,
     config: Configuration,