Simplify multi-module documentation #1387

sellmair · 2020-08-25T13:29:25Z

Closes #1265

core/src/main/kotlin/defaultConfiguration.kt

core/src/main/kotlin/model/Documentable.kt

...gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Collector0IntegrationTest.kt

runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder.kt

...base/src/main/kotlin/parsers/moduleAndPackage/parseModuleAndPackageDocumentationFragments.kt

plugins/base/src/main/kotlin/parsers/moduleAndPackage/ModuleAndPackageDocumentationSource.kt

Fix rebasing issue

… ("")

…rd` test

…e concept of `moduleDisplayName`

…rmer.kt

core/src/main/kotlin/defaultConfiguration.kt

core/src/main/kotlin/model/CompositeSourceSetID.kt

core/src/main/kotlin/model/Documentable.kt

Kordyjan · 2020-08-28T15:11:59Z

core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt

+    var pluginsClasspath: List<File> = emptyList()
+    var pluginsConfigurations: Map<String, String> = emptyMap()
+    var failOnWarning: Boolean = false
+    private val lazySourceSets = mutableListOf<Lazy<DokkaSourceSetImpl>>()


I think few things can be simplified if we were storing here not Lazy<DokkaSourceSetImpl> but (moduleName: String) -> DokkaSourceSetImpl. Especially we would get rid of strange restriction that module name must be defined before the sourcesets.

Oh. We should have continued this conversation here. Pawel and me talked about this in Slack:
Basically my argument here was, that making it the signature () -> DokkaSouceSetImpl would work, but it would just obfuscate the original contract which is: Yes this is lazy, but yes you will always get the same instance. IIRC, then we agreed on using Lazy here to signal this contract!

Kordyjan · 2020-08-28T15:14:51Z

plugins/base/base-test-utils/src/main/kotlin/renderers/defaultSourceSet.kt

-    suppressedFiles = emptySet(),
-    analysisPlatform = Platform.DEFAULT
-)
+val defaultSourceSet = testApi.testRunner.defaultSourceSet


Do we really need this file?

We would not, but that would require me to change a lot usages to refer to the new path. I putted this into a "lower" module, since I needed it there 🙄
Do you want me to go ahead changing all usages, or should I go with a Deprecated annotation?

Annotating it as deprecated would produce lots of warnings, wouldn't it?
I know that removing it will be a tedious process but for the sake of project we shouldn't have leftovers such as this in our repo. 😒

Done ✅ ☺️

Co-authored-by: Paweł Marks <[email protected]>

…in DModule and DPackage

plugins/base/base-test-utils/src/main/kotlin/renderers/defaultSourceSet.kt

sellmair added enhancement An issue for a feature or an overall improvement feedback: Kotlin libs Feedback from Kotlin's internal libraries runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin labels Aug 25, 2020

sellmair added this to the 1.4.10 milestone Aug 25, 2020

sellmair force-pushed the f/1265-multi-module-documentation branch 2 times, most recently from ee0ec51 to d32a1bf Compare August 26, 2020 13:40

sellmair mentioned this pull request Aug 26, 2020

Javadoc: root packages are not supported #1391

Closed

sellmair force-pushed the f/1265-multi-module-documentation branch 7 times, most recently from 81d2a76 to 4cbe1fc Compare August 28, 2020 06:20

sellmair marked this pull request as ready for review August 28, 2020 09:36

sellmair force-pushed the f/1265-multi-module-documentation branch from e57115e to 17c4ab9 Compare August 28, 2020 09:46

kamildoleglo suggested changes Aug 28, 2020

View reviewed changes

sellmair force-pushed the f/1265-multi-module-documentation branch 2 times, most recently from c56e4f5 to 354e0af Compare August 28, 2020 13:42

sellmair added 11 commits August 28, 2020 16:36

Implement ParseModuleAndPackageDocFragments API

da22ee1

Implement ModuleAndPackageDocumentationReader

208149d

Implement ModuleAndPackageDocumentationTransformerTest.kt

afecd47

Make testApi dokkaConfiguration available outside of AbstractCoreTest

a3f398c

Fix rebasing issue

Implement tests for ModuleAndPackageDocumentationReader

63147f3

Let DRI.packageName always be a real package name for root packages…

c2a0167

… ("")

WIP

e140fb3

Implement `root package is matched by empty string and the root keywo…

a650caa

…rd` test

Remove DRI.canonicalPackageName

4fca6b4

Let root package be represented as [root] to the user

1c73c5e

Let module name be configurable withing AbstractDokkaTask and remov…

01a36d3

…e concept of `moduleDisplayName`

sellmair added 5 commits August 28, 2020 16:38

Re-use includes form child tasks for all modules page generation

b459f8f

Minor readability improvement in ModuleAndPackageDocumentationTransfo…

0b93cfa

…rmer.kt

Remove unnecessary trailing comma in defaultConfiguration.kt

7e86b02

Remove unnecessary blank lines

bbf9bc1

Improve style of ModuleAndPackageDocumentationSource

50962e9

sellmair force-pushed the f/1265-multi-module-documentation branch from 7a124f5 to 50962e9 Compare August 28, 2020 14:40

Kordyjan reviewed Aug 28, 2020

View reviewed changes

sellmair and others added 3 commits August 28, 2020 18:06

CompositeSourceSetID: drop reduce in favour of joinToString

3538bf6

Co-authored-by: Paweł Marks <[email protected]>

Implement dPackage and dModule test APIs in favour of default params …

064b22b

…in DModule and DPackage

Remove old defaultSourceSet in favour of new package

c2dd962

sellmair modified the milestones: 1.4.10, 1.4.0-1 Aug 31, 2020

kamildoleglo reviewed Aug 31, 2020

View reviewed changes

plugins/base/base-test-utils/src/main/kotlin/renderers/defaultSourceSet.kt Show resolved Hide resolved

kamildoleglo approved these changes Aug 31, 2020

View reviewed changes

sellmair requested a review from Kordyjan August 31, 2020 13:06

Kordyjan approved these changes Aug 31, 2020

View reviewed changes

Kordyjan mentioned this pull request Aug 31, 2020

[Question] Export docs from different modules #292

Closed

sellmair merged commit 98c18f2 into master Aug 31, 2020

Kordyjan added the in:1.4.10 label Sep 13, 2020

sellmair mentioned this pull request Sep 14, 2020

MultiModule: Module description file containing only * bullets is not included #1322

Closed

IgnatBeresnev deleted the f/1265-multi-module-documentation branch May 18, 2023 00:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simplify multi-module documentation #1387

Simplify multi-module documentation #1387

sellmair commented Aug 25, 2020

Kordyjan Aug 28, 2020

kamildoleglo Aug 31, 2020

sellmair Aug 31, 2020

Kordyjan Aug 28, 2020

sellmair Aug 28, 2020

Kordyjan Aug 31, 2020

sellmair Aug 31, 2020

Simplify multi-module documentation #1387

Simplify multi-module documentation #1387

Conversation

sellmair commented Aug 25, 2020

Kordyjan Aug 28, 2020

Choose a reason for hiding this comment

kamildoleglo Aug 31, 2020

Choose a reason for hiding this comment

sellmair Aug 31, 2020

Choose a reason for hiding this comment

Kordyjan Aug 28, 2020

Choose a reason for hiding this comment

sellmair Aug 28, 2020

Choose a reason for hiding this comment

Kordyjan Aug 31, 2020

Choose a reason for hiding this comment

sellmair Aug 31, 2020

Choose a reason for hiding this comment