Giter Club home page Giter Club logo

Comments (2)

AngeloFilaseta avatar AngeloFilaseta commented on August 30, 2024

I investigated for a while. I'll write a bunch of considerations to explain what's going on and how we could treat this issue.
This problem is caused by the configuration of the dokkaJavadocCollector task. With the introduction of multiplatform projects in the build, an additional configuration for this task is required, as it would throw an exception otherwise:

Exception in thread "Thread-1029" org.jetbrains.dokka.DokkaException: Pre-generation validity check failed: Dokka Javadoc plugin currently does not support generating documentation for multiplatform project. Please, adjust your configuration

This exception is raised even if dokkaJavadoc and dokkaJavadocPartial get disabled in every multiplatform subproject. dokkaJavadocCollector task's configuration is a little embarrassing, as it is not possible to exclude certain subprojects (I mean, it is possible using the deprecated API).

To summarize, Dokka deprecated the API and did not suggest any viable alternatives to use at the moment. As the warning says, a sort of migration guide will be provided in the future.

To overcome this issue, we could keep everything as it is and wait for the migration guide to come out. This is not ideal, as it adds technical debt, but could possibly be treated easily in the future. Another way would be to manually create a "custom collector task". This might be a little overkill. Also, it would probably be hard and time wasting to configure, test etc.

If there are considerations, ideas, etc. on how to overcome this issue, I am willing to try them. If anything comes to my mind I'll update this issue.

Some useful links:
Dokka Collector Task documentation
The only related forum discussion I found in the whole web about this issue

from alchemist.

DanySK avatar DanySK commented on August 30, 2024

What about "disable individual project tasks using the Gradle API"? For this specific project, we only have one multiplatform module so far, should be manageable...

from alchemist.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.