Skip to content

Commit 7797527

Browse files
committed
Improve API documents
1 parent e869b0c commit 7797527

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ public interface IPublicAPI
223223
Task HttpDownloadAsync([NotNull] string url, [NotNull] string filePath, Action<double> reportProgress = null, CancellationToken token = default);
224224

225225
/// <summary>
226-
/// Add ActionKeyword and update action keyword metadata for specific plugin
226+
/// Add ActionKeyword and update action keyword metadata for specific plugin.
227227
/// Before adding, please check if action keyword is already assigned by <see cref="ActionKeywordAssigned"/>
228228
/// </summary>
229229
/// <param name="pluginId">ID for plugin that needs to add action keyword</param>
@@ -284,9 +284,10 @@ public interface IPublicAPI
284284
T LoadSettingJsonStorage<T>() where T : new();
285285

286286
/// <summary>
287-
/// Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.Launcher
287+
/// Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.
288288
/// This method will save the original instance loaded with LoadJsonStorage.
289-
/// This API call is for manually Save. Flow will automatically save all setting type that has called LoadSettingJsonStorage or SaveSettingJsonStorage previously.
289+
/// This API call is for manually Save.
290+
/// Flow will automatically save all setting type that has called <see cref="LoadSettingJsonStorage"/> or <see cref="SaveSettingJsonStorage"/> previously.
290291
/// </summary>
291292
/// <typeparam name="T">Type for Serialization</typeparam>
292293
/// <returns></returns>
@@ -428,9 +429,10 @@ public interface IPublicAPI
428429
Task<T> LoadCacheBinaryStorageAsync<T>(string cacheName, string cacheDirectory, T defaultData) where T : new();
429430

430431
/// <summary>
431-
/// Save BinaryStorage for current plugin's cache. This is the method used to save cache to binary in Flow.Launcher
432+
/// Save BinaryStorage for current plugin's cache. This is the method used to save cache to binary in Flow.
432433
/// This method will save the original instance loaded with LoadCacheBinaryStorageAsync.
433-
/// This API call is for manually Save. Flow will automatically save all cache type that has called LoadCacheBinaryStorageAsync or SaveCacheBinaryStorageAsync previously.
434+
/// This API call is for manually Save.
435+
/// Flow will automatically save all cache type that has called <see cref="LoadCacheBinaryStorageAsync"/> or <see cref="SaveCacheBinaryStorageAsync"/> previously.
434436
/// </summary>
435437
/// <typeparam name="T">Type for Serialization</typeparam>
436438
/// <param name="cacheName">Cache file name</param>

0 commit comments

Comments
 (0)