Hi, I'm building and sdk which gets shipped with d...

# dokka

[sebastien.rouif]

Hi, I'm building and sdk which gets shipped with documentation.
We used to create the documentation with regular Javadoc. Now that we have koltin classes we are migrating to Dokka. Some classes should not be documented. In Koltin it's easy as they are marked as internal withe the flag includeNonPublic = false in my Dokka configuration. In Java I can't find a way to do the same (previously we had a list of files or directory to document).
Is there anything I missed in the documentation ?

[semoro]

Is suppressing whole packages suitable for you?

[sebastien.rouif]

I considered that approach and that's the one I currently went for. I'm not sure yet as the previous approach was to include files to the javadoc. I'll keep you posted tomorrow.

[codeprogression]

If you want to hide a specific classes, you can add a suppression in the kdoc:

/**
 * @suppress
 */
class ShouldBeHidden

[sebastien.rouif]

thanks @codeprogression but the linter doesn't like it for java classes. Does it actually work on Java? my main concern is Java because as you said : I can use internal and @suppress for Kotlin

[codeprogression]

sorry - missed the "Java" part

[codeprogression]

I suppose @exclude would be appropriate for Javadoc. I don't know if that is honored by Dokka tho.

[codeprogression]

@exclude was a proposed tag - not sure it was ever actually adopted

[sebastien.rouif]

it seems like it's been requested for the past 20 years ... http://www.oracle.com/technetwork/java/javase/documentation/proposed-tags-142378.html

[codeprogression]

🙄