v2.1 升级指南

在 2.0 版本后,推荐根据注释自动生成组件/指令/服务的 API 文档。 修改 lib 的 apiMode 配置为 automatic 或者 compatible

  • 如果你的类库过去有手动定义的 API 文档,建议修改为compatible,这样会自动判断是否有 api 定义,如果没有定义会根据注释自动生成,这样可以逐渐替换
  • 如果你的类库是新的项目,建议采用automatic,不管有没有 api 定义,都根据注释自动生成
  • 2.1 版本的ng add @angular/cli会自动设置类库的apiMode为automatic

在 2.1 版本中,Docgeni 不会自动解析类库rootDir下的文件夹为组件

  • 如果你的类库rootDir下的文件夹就是组件,需要在include配置中新增''或者'./'
  • 如果你的类库rootDir下的src文件夹下才是组件,需要在include配置中新增'src'
  • 如果你的类库rootDir下的src/lib文件夹下才是组件,需要在include配置中新增'src/lib'
Open-source MIT Licensed | Copyright © 2020-present Powered by PingCode