ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-30 20:33:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Clarify that this only works for types shared by Dalamud.

Browse source
This commit is contained in:
Ottermandias 2022-10-28 16:55:28 +02:00
parent 293590bd51
commit 59cc4d3321
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Dalamud/Plugin/Ipc/Internal/DataShare.cs
View file

@ -25,7 +25,7 @@ internal class DataShare : IServiceType
/// Otherwise, call the function <paramref name="dataGenerator"/> to create data and store it as a new cache. /// Otherwise, call the function <paramref name="dataGenerator"/> to create data and store it as a new cache.
/// In either case, the calling assembly will be added to the current consumers on success. /// In either case, the calling assembly will be added to the current consumers on success.
/// </summary> /// </summary>
/// <typeparam name="T">The type of the stored data - needs to be a reference type.</typeparam> /// <typeparam name="T">The type of the stored data - needs to be a reference type that is shared through Dalamud itself, not loaded by the plugin.</typeparam>
/// <param name="tag">The name for the data cache.</param> /// <param name="tag">The name for the data cache.</param>
/// <param name="dataGenerator">The function that generates the data if it does not already exist.</param> /// <param name="dataGenerator">The function that generates the data if it does not already exist.</param>
/// <returns>Either the existing data for <paramref name="tag"/> or the data generated by <paramref name="dataGenerator"/>.</returns> /// <returns>Either the existing data for <paramref name="tag"/> or the data generated by <paramref name="dataGenerator"/>.</returns>
@ -82,7 +82,7 @@ internal class DataShare : IServiceType
/// Obtain the data for the given <paramref name="tag"/>, if it exists and has the correct type. /// Obtain the data for the given <paramref name="tag"/>, if it exists and has the correct type.
/// Add the calling assembly to the current consumers if true is returned. /// Add the calling assembly to the current consumers if true is returned.
/// </summary> /// </summary>
/// <typeparam name="T">The type for the requested data - needs to be a reference type.</typeparam> /// <typeparam name="T">The type of the stored data - needs to be a reference type that is shared through Dalamud itself, not loaded by the plugin.</typeparam>
/// <param name="tag">The name for the data cache.</param> /// <param name="tag">The name for the data cache.</param>
/// <param name="data">The requested data on success, null otherwise.</param> /// <param name="data">The requested data on success, null otherwise.</param>
/// <returns>True if the requested data exists and is assignable to the requested type.</returns> /// <returns>True if the requested data exists and is assignable to the requested type.</returns>
@ -106,7 +106,7 @@ internal class DataShare : IServiceType
/// Obtain the data for the given <paramref name="tag"/>, if it exists and has the correct type. /// Obtain the data for the given <paramref name="tag"/>, if it exists and has the correct type.
/// Add the calling assembly to the current consumers if non-null is returned. /// Add the calling assembly to the current consumers if non-null is returned.
/// </summary> /// </summary>
/// <typeparam name="T">The type for the requested data - needs to be a reference type.</typeparam> /// <typeparam name="T">The type of the stored data - needs to be a reference type that is shared through Dalamud itself, not loaded by the plugin.</typeparam>
/// <param name="tag">The name for the data cache.</param> /// <param name="tag">The name for the data cache.</param>
/// <returns>The requested data</returns> /// <returns>The requested data</returns>
/// <exception cref="KeyNotFoundException">Thrown if <paramref name="tag"/> is not registered.</exception> /// <exception cref="KeyNotFoundException">Thrown if <paramref name="tag"/> is not registered.</exception>