From 8cd28416817dfd7d28bb66b28e849d97cc09012b Mon Sep 17 00:00:00 2001
From: "sebastian.sellmair" <sebastian.sellmair@jetbrains.com>
Date: Thu, 27 Aug 2020 15:50:40 +0200
Subject: Let module name be configurable withing `AbstractDokkaTask` and
 remove concept of `moduleDisplayName`

---
 README.md | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 19aff3b6..ed2d38c2 100644
--- a/README.md
+++ b/README.md
@@ -141,7 +141,6 @@ dokkaHtml {
     cacheRoot.set(file("default"))
     dokkaSourceSets {
         configureEach { // Or source set name, for single-platform the default source sets are `main` and `test`
-            moduleDisplayName.set("data")
 
             // Used when configuring source sets manually for declaring which source sets this one depends on
             dependsOn("otherSourceSetName")
@@ -407,7 +406,7 @@ The available configuration options are shown below:
         <skip>false</skip>
     
         <!-- Default: ${project.artifactId} -->
-        <moduleDisplayName>data</moduleDisplayName>
+        <moduleName>data</moduleName>
 
         <!-- Default: ${project.basedir}/target/dokka -->
         <outputDir>some/out/dir</outputDir>
@@ -556,7 +555,6 @@ Dokka supports the following command line arguments:
   * `-globalSrcLink` - source links added to all source sets
   * `-sourceSet` - (repeatable) - configuration for a single source set. Following this argument, you can pass other arguments:
     * `-moduleName` - (required) - module name used as a part of source set ID when declaring dependent source sets
-    * `-moduleDisplayName` - displayed module name
     * `-sourceSetName` - source set name as a part of source set ID when declaring dependent source sets
     * `-displayName` - source set name displayed in the generated documentation
     * `-src` - list of source files or directories separated by `;`
-- 
cgit