From d7f0c2f6dd143d60ceae9e305f75ba01cf38bbcf Mon Sep 17 00:00:00 2001
From: Dominique FOURNIER <dominique.fournier@grenoble.cnrs.fr>
Date: Tue, 6 Sep 2022 16:41:46 +0200
Subject: [PATCH] Better @return description

---
 src/Certificationauthority.php | 10 +++++-----
 src/File.php                   |  2 +-
 src/Macaddresses.php           |  2 +-
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/Certificationauthority.php b/src/Certificationauthority.php
index e4e2819..2677d40 100644
--- a/src/Certificationauthority.php
+++ b/src/Certificationauthority.php
@@ -121,7 +121,7 @@ extendedKeyUsage = serverAuth, clientAuth
 
   /** Get/Set the ca cert
     * @param string|null $caCert The CA cert to get/set
-    * @return the CA if get in PEM, $this if set
+    * @return string|self the CA if get in PEM, $this if set
     */
   public function caCert ($caCert = null)
   // {{{
@@ -137,7 +137,7 @@ extendedKeyUsage = serverAuth, clientAuth
 
   /** Get/Set the ca key
     * @param string|null $caKey The CA key to get/set
-    * @return the CA if get, $this if set
+    * @return string|self the CA if get, $this if set
     */
   public function caKey ($caKey = null)
   // {{{
@@ -168,7 +168,7 @@ extendedKeyUsage = serverAuth, clientAuth
 
   /** Get in PEM/Set the private key
     * @param string|null $privateKey The private key to use
-    * @return the privatekey if get in PEM, $this if set
+    * @return string|self the privatekey if get in PEM, $this if set
     */
   public function privateKey ($privateKey = null)
   // {{{
@@ -191,7 +191,7 @@ extendedKeyUsage = serverAuth, clientAuth
     * @param string $countryName Country name (like FR)
     * @param string $organizationName Name of organization
     * @param string $commonName Common name of authority
-    * @return the CSR created in PEM
+    * @return string the CSR created in PEM
     */
   public function createCSR ($countryName, $organizationName, $commonName)
   // {{{
@@ -221,7 +221,7 @@ extendedKeyUsage = serverAuth, clientAuth
     * @param string $caKey The CA private key
     * @param integer|null $days The number of days of validity (365 by default)
     * @param array|null $altNames The alternative names allowed in cert
-    * @return the signed certificate in PEM
+    * @return string the signed certificate in PEM
     */
   public function signCSR ($csr, $caCert, $caKey, $days = 365,
     $altNames = array ())
diff --git a/src/File.php b/src/File.php
index c9b8e37..c866f3e 100644
--- a/src/File.php
+++ b/src/File.php
@@ -230,7 +230,7 @@ class File
 
   /** Write a string to a file
     * @param string $filename Path to the file where to write the data
-    * @param string $data The data to write
+    * @param string|integer $data The data to write
     * @param integer|null $flags The optional flags
     * @return integer the length of the data stored
     * @throws If parent directory not exists, is not writeable, or the file
diff --git a/src/Macaddresses.php b/src/Macaddresses.php
index c65bbc7..40f987b 100644
--- a/src/Macaddresses.php
+++ b/src/Macaddresses.php
@@ -61,7 +61,7 @@ class Macaddresses
   /** Remove all the separators from the provided MAC address
     * @param string $mac the mac address to update
     * @param array|null $separators The separators to remove
-    * @return the updated mac address without separators
+    * @return string the updated mac address without separators
     */
   public static function removeSeparator ($mac,
     $separators = array (":", "-", "."))