【问题标题】:KDoc / Dokka: Ignore inherited methods in subclassKDoc / Dokka:忽略子类中的继承方法
【发布时间】:2020-12-13 21:54:45
【问题描述】:

我正在使用 KDoc/Dokka 为 android 库生成文档。

我有一个自定义视图,它扩展了LinearLayout

问题在于LinearLayout 包含数百个公共方法。 Dokka 为所有这些方法生成空文档,即使我没有在自己的代码中使用或覆盖它们。

这完全掩盖了我自己的任何方法,并使文档几乎毫无用处。

如何防止 dokka 为继承的方法生成文档?

【问题讨论】:

    标签: android kotlin kotlin-dokka kdoc


    【解决方案1】:

    目前不支持此功能,可能我们会添加一些标志来打开/关闭它。

    你可以关注这个问题:https://github.com/Kotlin/dokka/issues/1501

    【讨论】:

      【解决方案2】:

      根据@andrzej-ratajczak 的回答,可以使用以下内容

      pluginsMapConfiguration.set(
        ["org.jetbrains.dokka.base.DokkaBase": """{ "separateInheritedMembers": true}"""]
      )
      

      这里是我自己的模块示例

      dokkaHtml {
          moduleName = "${project.name}"
      
          dokkaSourceSets {
              configureEach {
                  // Suppress a package
                  perPackageOption {
                      // will match all packages and sub-packages
                      matchingRegex.set(".*\\.internal.*")
                      suppress.set(true)
                  }
      
                  // separate inherited members to avoid polluting our public API
                  // https://github.com/Kotlin/dokka/issues/1501
                  pluginsMapConfiguration.set(
                          ["org.jetbrains.dokka.base.DokkaBase": """{ "separateInheritedMembers": true}"""]
                  )
      
              }
          }
      }
      

      【讨论】:

        猜你喜欢
        • 2020-11-09
        • 2016-06-17
        • 2022-01-25
        • 2016-07-21
        • 2021-06-13
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多