mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-03-22 10:34:30 +08:00
docs(architecture): 为IArchitecture接口添加文档注释
- 为RegisterSystem方法添加返回值文档注释 - 为RegisterModel方法添加返回值文档注释 - 为RegisterUtility方法添加返回值文档注释 - 为IArchitecture接口添加WaitUntilReadyAsync方法 - 为新添加的方法添加完整的XML文档注释
This commit is contained in:
parent
50e334b006
commit
a71c7f6f1a
@ -36,6 +36,7 @@ public interface IArchitecture : IAsyncInitializable
|
||||
/// </summary>
|
||||
/// <typeparam name="T">系统类型,必须实现ISystem接口</typeparam>
|
||||
/// <param name="system">要注册的系统实例</param>
|
||||
/// <returns>注册的系统实例</returns>
|
||||
T RegisterSystem<T>(T system) where T : ISystem;
|
||||
|
||||
/// <summary>
|
||||
@ -43,6 +44,7 @@ public interface IArchitecture : IAsyncInitializable
|
||||
/// </summary>
|
||||
/// <typeparam name="T">模型类型,必须实现IModel接口</typeparam>
|
||||
/// <param name="model">要注册的模型实例</param>
|
||||
/// <returns>注册的模型实例</returns>
|
||||
T RegisterModel<T>(T model) where T : IModel;
|
||||
|
||||
/// <summary>
|
||||
@ -50,6 +52,7 @@ public interface IArchitecture : IAsyncInitializable
|
||||
/// </summary>
|
||||
/// <typeparam name="T">工具类型,必须实现IUtility接口</typeparam>
|
||||
/// <param name="utility">要注册的工具实例</param>
|
||||
/// <returns>注册的工具实例</returns>
|
||||
T RegisterUtility<T>(T utility) where T : IUtility;
|
||||
|
||||
/// <summary>
|
||||
@ -65,4 +68,10 @@ public interface IArchitecture : IAsyncInitializable
|
||||
/// <param name="hook">生命周期钩子实例</param>
|
||||
/// <returns>注册的钩子实例</returns>
|
||||
IArchitectureLifecycle RegisterLifecycleHook(IArchitectureLifecycle hook);
|
||||
|
||||
/// <summary>
|
||||
/// 等待直到架构准备就绪的异步操作
|
||||
/// </summary>
|
||||
/// <returns>表示异步等待操作的任务</returns>
|
||||
Task WaitUntilReadyAsync();
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user