Allow to specify order of modules in the multi-module documentation page in DokkaMultiModuleTask #2849
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…age in DokkaMultiModuleTask And then preserve that order of modules in other places.
ilya-g
commented
Feb 6, 2023
|
|
||
| class AddToNavigationCommandHandler(val context: DokkaContext) : CommandHandler { | ||
| private val navigationFragments = ConcurrentHashMap<String, Element>() | ||
| private val navigationFragments = Collections.synchronizedList(mutableListOf<Pair<String, Element>>()) |
There was a problem hiding this comment.
I don't know why a ConcurrentHashMap was there. Is it supposed to work in a multi-threaded context?
Comment on lines
+55
to
+57
| @Internal | ||
| val moduleOrder: Property<DokkaMultiModuleOrder> = project.objects.safeProperty<DokkaMultiModuleOrder>() | ||
| .safeConvention(DokkaMultiModuleOrder.Default) |
There was a problem hiding this comment.
This has a problem that such property is not included in the cache key, therefore changing just the order won't rebuild the documentation.
|
Perhaps another approach for ordering would be to introduce some new property, Int or String, in the Dokka partial task, so that the modules will be sorted first by the specified property value (nulls last), and then by their relative path as they are sorted now. |
|
This has the potential to fix #1868 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow to specify order of modules in the multi-module documentation page in DokkaMultiModuleTask and then preserve that order of modules in other places.