程序包 com.iohao.game.action.skeleton.core.doc

类 IoGameDocumentHelper

java.lang.Object
com.iohao.game.action.skeleton.core.doc.IoGameDocumentHelper
public class IoGameDocumentHelper extends Object
对接文档生成器辅助，游戏对接文档生成

for example 


     // 添加自定义的文档生成器
     IoGameDocumentHelper.addDocumentGenerate(new YourDocumentGenerate());
     // 添加枚举错误码 class，用于生成错误码相关信息
     IoGameDocumentHelper.addErrorCodeClass(YourGameCode.class);
     // 生成文档
     IoGameDocumentHelper.generateDocument();
作者:
渔民小镇
另请参阅:
日期:
2024-07-05

  • 构造器详细资料

    • IoGameDocumentHelper

      public IoGameDocumentHelper()

  • 方法详细资料

    • setGenerateDoc

      public void setGenerateDoc(boolean generateDoc)
      只有当 generateDoc 为 true 时，才会执行 set 操作
      参数:
      generateDoc - generateDoc，当为 false 时，将不会生成文档

    • generateDocument

      public void generateDocument()
      对接文档生成

    • addDocumentGenerate

      public void addDocumentGenerate(DocumentGenerate documentGenerate)
      添加文档生成器，相同类型只能添加一个
      参数:
      documentGenerate - 文档生成接口

    • addErrorCodeClass

      public void addErrorCodeClass(Class<? extends MsgExceptionInfo> clazz)
      添加枚举错误码 class 
           参考 ActionErrorEnum 的实现
      参数:
      clazz - 枚举错误码 class

    • addBroadcastDocument

      public void addBroadcastDocument(BroadcastDocument broadcastDocument)
      添加广播文档
      参数:
      broadcastDocument - broadcastDocument

    • ofActionDoc

      public ActionDoc ofActionDoc(int cmd, Class<?> controllerClazz)
      获取 ActionDoc，如果 ActionDoc 不存在则创建
      参数:
      cmd - 主路由
      controllerClazz - action class
      返回:
      一定不为 null