Add example to DocBlock

Signed-off-by: Christopher Ng <chrng8@gmail.com>

diff --git a/lib/public/Accounts/IAccount.php b/lib/public/Accounts/IAccount.php
index dcec17f9363d0b8692f8a6519ab333abe8f838d9..383f21068a994e7014d4edee1f9d46881726bcc5 100644 (file)
--- a/lib/public/Accounts/IAccount.php
+++ b/lib/public/Accounts/IAccount.php
@@ -76,6 +76,40 @@ interface IAccount extends \JsonSerializable {
         *
         * @param array<string, array<string, string>>|array<string, array<int, array<string, string>>> $properties
         *
+        * e.g. `[
+        *   'displayname' => [
+        *     'name' => 'displayname',
+        *     'value' => 'Jonathan Smith',
+        *     'scope' => 'v2-federated',
+        *     'verified' => '0',
+        *     'verificationData' => '',
+        *   ],
+        *   'email' => [
+        *     'name' => 'email',
+        *     'value' => 'jonathan@example.org',
+        *     'scope' => 'v2-federated',
+        *     'verified' => '0',
+        *     'verificationData' => '',
+        *   ],
+        *   // ...
+        *   'additional_mail' => [
+        *     [
+        *       'name' => 'additional_mail',
+        *       'value' => 'jon@example.org',
+        *       'scope' => 'v2-local',
+        *       'verified' => '0',
+        *       'verificationData' => '',
+        *     ],
+        *     [
+        *       'name' => 'additional_mail',
+        *       'value' => 'jon@earth.org',
+        *       'scope' => 'v2-local',
+        *       'verified' => '0',
+        *       'verificationData' => '',
+        *     ],
+        *   ],
+        * ]`
+        *
         * @since 24.0.0
         */
        public function setAllPropertiesFromJson(array $properties): IAccount;