Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not able to add the private members into the html output. #3994

Open
gitvignesh opened this issue Jan 14, 2025 · 0 comments
Open

Not able to add the private members into the html output. #3994

gitvignesh opened this issue Jan 14, 2025 · 0 comments
Labels

Comments

@gitvignesh
Copy link

gitvignesh commented Jan 14, 2025

Describe the bug
Private members don't show up in the HTML output even if it's enabled.

To Reproduce
I am using gradel groovy.

Dokka configuration

// Dokka source set configuration
tasks.withType(DokkaTask.class).configureEach {
    // Dokka plugin options
    String dokkaBaseConfiguration = """
    {
      "footerMessage": "(c) 2025 Company"
    }
    """
    pluginsMapConfiguration.set(["org.jetbrains.dokka.base.DokkaBase": dokkaBaseConfiguration])

    dokkaSourceSets {
        named("main") {
            moduleName.set("AudiOn")
            includes.from("docs/packages_overview.md")

            sourceLink {
                localDirectory.set(file("src/main/java/com/globaldelight/audiorecorder"))
                remoteUrl.set(URL("https://developer.android.com/reference/"))
                remoteLineSuffix.set("#L")
            }

            // Enable inclusion of non-public (e.g., private, protected) members
            includeNonPublic = true

            // Allow documenting private members by setting the visibility level
            documentedVisibilities = [DokkaConfiguration.Visibility.PRIVATE]

            // Additional configuration
            skipDeprecated = true
            reportUndocumented = true
        }
    }

    outputDirectory.set(file("$buildDir/documentation"))
}
@gitvignesh gitvignesh added the bug label Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant