Add debug utility for manually overriding the Dokka configuration JSON #3915
Conversation
35f775e to
608811d
Compare
Being able to make minor manual modifications to the Dokka configuration is exceptionally useful for local debugging. This should not be used in production, and it is protected by an opt-in API.
608811d to
3d75dae
Compare
For example, @antohaby and I looked at improving KMP handling. It was convenient to be able to manually modify the Dokka configuration rather than trying to modify the Gradle config that DGP uses to produce the Dokka config. For example, we could manually add/remove files from the dependencies that Dokka Generator analyses, or change the order of the files. Changing the order of the files would be quite difficult to do by modifying the Gradle build config. So, instead we added this util. So we could run |
| val dokkaConfiguration = | ||
| if (overrideJsonConfig.isPresent) { | ||
| logger.warn("w: [$path] Overriding DokkaConfiguration with manualJsonConfig") | ||
| DokkaConfigurationImpl(overrideJsonConfig.get()) |
There was a problem hiding this comment.
what's manualJsonConfig ? I don't see it anywhere. Perhaps you meant overrideJsonConfig :)
|
I'm afraid it can be abused in the future. But on the other hand why not? someone can also apply patches to the json files when necessary. |
Being able to make minor manual modifications to the Dokka configuration is exceptionally useful for local debugging.
This should not be used in production, and it is protected by an opt-in API.