Clarify that CaPath is a directory and not a file

amphp · Dec 29, 2023 · 9a85522 · 9a85522
1 parent 88ca6d2
commit 9a85522
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/src/ClientTlsContext.php b/src/ClientTlsContext.php
@@ -205,7 +205,7 @@ public function withCaFile(string $cafile = null): self
  }
 
  /**
- * @return null|string Path to the file if one is set, otherwise `null`.
+ * @return null|string Path to the trusted certificates file if one is set, otherwise `null`.
  */
  public function getCaFile(): ?string
  {
@@ -215,7 +215,7 @@ public function getCaFile(): ?string
  /**
  * CAPath to check for trusted certificates.
  *
- * @param string|null $capath Path to the file or `null` to unset.
+ * @param string|null $capath Path to the directory or `null` to unset.
  *
  * @return self Cloned, modified instance.
  */
@@ -228,7 +228,7 @@ public function withCaPath(string $capath = null): self
  }
 
  /**
- * @return null|string Path to the file if one is set, otherwise `null`.
+ * @return null|string Path to the trusted certificate directory if one is set, otherwise `null`.
  */
  public function getCaPath(): ?string
  {

diff --git a/src/ServerTlsContext.php b/src/ServerTlsContext.php
@@ -232,7 +232,7 @@ public function withCaFile(string $cafile = null): self
  }
 
  /**
- * @return null|string Path to the file if one is set, otherwise `null`.
+ * @return null|string Path to the trusted certificates file if one is set, otherwise `null`.
  */
  public function getCaFile(): ?string
  {
@@ -242,7 +242,7 @@ public function getCaFile(): ?string
  /**
  * CAPath to check for trusted certificates.
  *
- * @param string|null $capath Path to the file or `null` to unset.
+ * @param string|null $capath Path to the directory or `null` to unset.
  *
  * @return self Cloned, modified instance.
  */
@@ -255,7 +255,7 @@ public function withCaPath(string $capath = null): self
  }
 
  /**
- * @return null|string Path to the file if one is set, otherwise `null`.
+ * @return null|string Path to the trusted certificate directory if one is set, otherwise `null`.
  */
  public function getCaPath(): ?string
  {