From 04b2765d72f4200da79869414442e949f1b30898 Mon Sep 17 00:00:00 2001
From: Stephan <stephane@umbraco.dk>
Date: Fri, 7 Dec 2018 09:03:36 +0100
Subject: [PATCH] Document

---
 .../PropertyEditors/IPropertyIndexValueFactory.cs         | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/Umbraco.Core/PropertyEditors/IPropertyIndexValueFactory.cs b/src/Umbraco.Core/PropertyEditors/IPropertyIndexValueFactory.cs
index e303a53f5f..fd4e272f08 100644
--- a/src/Umbraco.Core/PropertyEditors/IPropertyIndexValueFactory.cs
+++ b/src/Umbraco.Core/PropertyEditors/IPropertyIndexValueFactory.cs
@@ -11,6 +11,14 @@ namespace Umbraco.Core.PropertyEditors
         /// <summary>
         /// Gets the index values for a property.
         /// </summary>
+        /// <remarks>
+        /// <para>Returns key-value pairs, where keys are indexed field names. By default, that would be the property alias,
+        /// and there would be only one pair, but some implementations (see for instance the grid one) may return more than
+        /// one pair, with different indexed field names.</para>
+        /// <para>And then, values are an enumerable of objects, because each indexed field can in turn have multiple
+        /// values. By default, there would be only one object: the property value. But some implementations may return
+        /// more than one value for a given field.</para>
+        /// </remarks>
         IEnumerable<KeyValuePair<string, IEnumerable<object>>> GetIndexValues(Property property, string culture, string segment, bool published);
     }
 }