Merge pull request #911 from Sergio0694/dev/update-effect-factory-docs

Improve XML docs for `EffectFactory`

Author: Sergio0694

src/ComputeSharp.D2D1/Interfaces/Descriptors/ID2D1PixelShaderDescriptor{T}.cs

@@ -60,7 +60,8 @@ public interface ID2D1PixelShaderDescriptor<T>
     /// This only applies to effects created from <see cref="D2D1PixelShaderEffect"/>.
     /// </para>
     /// <para>
-    /// The returned function pointer should have a signature matching <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nc-d2d1_1-pd2d1_effect_factory"><c>PD2D1_EFFECT_FACTORY</c></a>.
+    /// The returned function pointer should have a signature matching <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nc-d2d1_1-pd2d1_effect_factory"><c>PD2D1_EFFECT_FACTORY</c></a>,
+    /// and it should point to a method calling <see cref="D2D1PixelShaderEffect.CreateEffectUnsafe"/>. Using other D2D effect implementations is not a supported scenario, and might not work correctly.
     /// </para>
     /// </remarks>
     static abstract nint EffectFactory { get; }

src/ComputeSharp.D2D1/Shaders/Interop/D2D1PixelShaderEffect.cs

@@ -86,8 +86,11 @@ public static ref readonly Guid GetEffectId<T>()
     /// </para>
     /// <para>
     /// This method is guaranteed to never throw an exception, and can be used directly in a method exported to native code.
+    /// </para>
+    /// <para>
     /// The main use case scenario for calling <see cref="CreateEffectUnsafe"/> is to produce the factory for
-    /// <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nf-d2d1_1-id2d1factory1-registereffectfromstring"><c>ID2D1Factory1::RegisterEffectFromString</c></a>.
+    /// <a href="https://learn.microsoft.com/windows/win32/api/d2d1_1/nf-d2d1_1-id2d1factory1-registereffectfromstring"><c>ID2D1Factory1::RegisterEffectFromString</c></a>,
+    /// which should then be returned from <see cref="ID2D1PixelShaderDescriptor{T}.EffectFactory"/> implementations (either generated or manually authored).
     /// </para>
     /// </remarks>
     public static int CreateEffectUnsafe<T>(void** effectImpl)