标签: kotlin-dokka

我正在关注https://github.com/Kotlin/dokka中的gradle插件部分。

我还在https://github.com/JetBrains/kotlin-examples/tree/master/gradle/dokka-gradle-example中尝试了dokka-gradle-example示例。

我使用的版本是：

android: '23.1.1'
dokka: '0.9.6'
gradle-android-plugin: '1.5.0'
kotlin: '1.0.0-rc-1036'

但我也尝试使用0.9到0.9.7之间的Dokka版本。

输出的相关部分是：

...

:app:dokka FAILED
:app:dokka (Thread[Daemon worker Thread 9,5,main]) completed. Took 0.766 secs.

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':app:dokka'.
> com.intellij.mock.MockComponentManager.getPicoContainer()Lorg/picocontainer/MutablePicoContainer;

* Try:
Run with --debug option to get more log output.

* Exception is:
org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':app:dokka'.
    at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeActions(ExecuteActionsTaskExecuter.java:69)
    at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.execute(ExecuteActionsTaskExecuter.java:46)
    at org.gradle.api.internal.tasks.execution.PostExecutionAnalysisTaskExecuter.execute(PostExecutionAnalysisTaskExecuter.java:35)
    at org.gradle.api.internal.tasks.execution.SkipUpToDateTaskExecuter.execute(SkipUpToDateTaskExecuter.java:64)
    at org.gradle.api.internal.tasks.execution.ValidatingTaskExecuter.execute(ValidatingTaskExecuter.java:58)
    at org.gradle.api.internal.tasks.execution.SkipEmptySourceFilesTaskExecuter.execute(SkipEmptySourceFilesTaskExecuter.java:42)
    at org.gradle.api.internal.tasks.execution.SkipTaskWithNoActionsExecuter.execute(SkipTaskWithNoActionsExecuter.java:52) …

我正在尝试在Kotlin项目中使用dokka插件，但收到以下消息：

错误：（7，0）找不到ID为'org.jetbrains.dokka'的插件。

我正在使用Android Studio 3.0版。

提前致谢。

我目前正在测试 Dokka 文档，我所做的一些注释没有被渲染。以下是我的发现：

1. 类不显示@sample, 和 html 标签<p></p>, <h1></h1>: 请参阅 SimpleCalculator类文档
2. 如果描述位于 html 标签下，则不会显示：请参阅enum class OPERATOR代码文档
3. 方法根本不显示@sample：@property请参阅所有方法代码文档
4. @property和之间的定义混合@param。在类声明中， the@param是 a 内的那个<>（例如Group<T>）。但在方法中，它是参数内的那个。

请看我的代码：

package example

/**
 * <h1> A Simple Calculator for your daily needs! </h1>
 *
 * <p> This class can help you add, subract, multiply and divide Integers </p>
 *
 * @property firstNumber the first Number you want to …

作为构建我的项目的一部分，我希望 Dokka 的 maven 插件构建一个 Markdown wiki，我可以将其部署到 github 而无需修改。我构建 Markdown 并通过 intellij 查看文档没有问题，但我希望将它直接托管在我项目的 github wiki 中。如果有人有任何想法如何做到这一点，那就太好了。

这是我目前的 Dokka 配置

        <plugin>
            <groupId>org.jetbrains.dokka</groupId>
            <artifactId>dokka-maven-plugin</artifactId>
            <version>0.9.16</version>
            <executions>
                <execution>
                    <phase>pre-site</phase>
                    <goals>
                        <goal>dokka</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <!-- Set to true to skip dokka task, default: false -->
                <skip>false</skip>

                <outputFormat>gfm</outputFormat>

                <!-- Default: ${project.basedir}/target/dokka -->
                <outputDir>${project.basedir}/docs/privateurl</outputDir>

                <!-- Use default or set to custom path to cache directory to enable package-list caching. -->
                <!-- When set to default, caches stored in $USER_HOME/.cache/dokka -->
                <cacheRoot>default</cacheRoot>

                <!-- List of …

我正在尝试使用 Dokka 从我的 Kotlin 项目生成文档。我正在使用 0.9.17 版本。

这是我的 gradle 配置：

dokka {
    includes = ['../README.md']
    outputFormat = 'html'
    outputDirectory = "$buildDir/outputs/doc"

    // Use to include or exclude non public members.
    includeNonPublic = false

    // Do not create index pages for empty packages
    skipEmptyPackages = true

    packageOptions {
        prefix = 'com.app.internal'
        suppress = true
    }
    // No default documentation link to kotlin-stdlib
    noStdlibLink = true
}

要生成文档，我使用以下命令：

./gradlew dokka

但是有一个问题（否则我不会问你^^）。我遇到的问题是：

FAILURE: Build failed with an exception.

* What went wrong:
Execution …

我正在寻找一种在所有 Dokka 生成的文档的页脚中包含文本的方法。我没有看到 Dokka 的 Gradle 或 Maven 插件宣传此选项。

这可能吗？你能给我指一个样本吗？

我正在尝试为我的 kotlin 代码生成文档。我的一些类和函数有 KDOC 注释。

我试图像这样从 CLI 运行 dokka：

java -jar dokka-cli-1.4.20.jar

结果是：

警告：Dokka 1.4.* 是一个 alpha 项目进度：初始化插件加载插件：[] 加载：[

] 抑制：[

] PROGRESS：有效性检查 PROGRESS：创建文档模型 PROGRESS：退出生成：没有任何记录 PROGRESS：

=== 时间测量 ===

               Initializing plugins: 26
                     Validity check: 32
      Creating documentation models: 28 
      Exiting Generation: Nothing to document:  1

Run Code Online (Sandbox Code Playgroud)

我试图执行这个：

• 在项目的文件夹中。
• 在 src 文件夹中
• 在具有 .kt 文件的第一个 src 子文件夹中

所有运行的结果都相似。

关于如何解决这个问题的任何想法？谢谢。

我想在我的 Kotlin 文档中提供代码示例，并且我发现文档@sample <identifier>中有一个关键字。但我不确定我应该做什么。

由于KDoc文档生成引擎被放弃以支持Dokka,Kotlin文档应该被称为"KDoc评论",还是"Dokka评论"？

我最近将一个 java 组件迁移到 kotlin。到目前为止，当我使用maven发布插件时，它也自动生成了javadoc，并且也上传到了oss.sonatype.com。另一方面，Dokka 似乎没有与开箱即用的发布插件集成。结果，上传到 oss.sonatype.com 后，nexus 拒绝发布并出现验证错误，因为 javadoc jar 丢失。

dokka 是否与 Maven 发布插件集成？

试图用一个非常常规的结构来记录一些Kotlin代码:

1. 编号列表.
   • 带有项目符号子列表.
2. 数字在列表的顶层正确继续的位置.

我所采取的官方Dokka页面甚至没有页面上的"列表"一词.谷歌搜索没有找到任何关于如何做到这一点的信息.救命!

我想添加这样的评论

  /**
   * @param scrollFraction In range [0..1].
   */

但是Dokka / Kdoc将方括号内的内容解释为参考。当您在IDE中检查函数的文档或生成文档时，这会导致注释呈现效果很差。如何在Dokka / Kdoc中转义方括号/其他符号？