Hi, how can I fix the issue where the class name i...
# dokka
j
Hi, how can I fix the issue where the class name is not picked up in a multi module project? Is it possible to just print the class name without linking to it?
<Error class: unknown class>
Also, if i can't simply print the class name is there a way to link between modules? (I'm using the CLI approach also)
o
Hey! could you please describe a bit more on what is the issue? Does Dokka can't resolve class from another module? or from dependency?
Is it possible to just print the class name without linking to it?
Unfortunately, no
j
Hi @Oleg Yukhnevich 🙂 I have a multi module set up using the CLI, and some of the classes are from parts of the codebase that are not documented by dokka, this error comes up during the dokka generation of a module I am documenting. An example is below. I don't necessarily want to include all of these classes in our documentation right now, but also don't want this string to display in the class that I am documenting. What are the options here? Thanks for getting back to me too!
o
Hm, probably you should be able to achieve this by providing those
parts of the codebase that are not documented by dokka
via
classpath
property in source set configuration, only jars (or klibs in kmp) are supported there In this case, those
Error class
errors should be resolved to just plain names, but no links will be generated - so looks like there is a possibility in the end in this case 🙂
j
Sorry it was a stat holiday here yesterday 🙂 if classpaths only support jars though how would I add certain classes/folders to it?
o
yeah, classpath accepts only jars, so they should be built Another, probably a bit more complex and strange alternative is to provide sources (folders/classes) from other module into both
sourceRoots
and
suppressedFiles
- In this case, Dokka will analyze those additional sources (and so should resolve those class name), but it should not generate documentation for them
j
Thanks I can try that! Is there any plan on the roadmap to allow an option to just print the classname instead of the error message?
o
There is an issue for this: https://github.com/Kotlin/dokka/issues/503 But no plans to implement this right now
j
No problem, thanks for the help I appreciate it 🙂
thank you color 1