From c505bb144954821a86a57a496d2a31d9f6f6cb1f Mon Sep 17 00:00:00 2001
From: Christopher Ng <chrng8@gmail.com>
Date: Thu, 17 Mar 2022 04:26:24 +0000
Subject: Add example to DocBlock

Signed-off-by: Christopher Ng <chrng8@gmail.com>
---
 lib/public/Accounts/IAccount.php | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

(limited to 'lib')

diff --git a/lib/public/Accounts/IAccount.php b/lib/public/Accounts/IAccount.php
index dcec17f9363..383f21068a9 100644
--- 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;
-- 
cgit v1.2.3