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

Params are not properly generated for java classes. #465

Closed
mp2019 opened this issue Apr 11, 2019 · 3 comments
Closed

Params are not properly generated for java classes. #465

mp2019 opened this issue Apr 11, 2019 · 3 comments
Assignees
Labels
format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general regression An issue/bug that appeared after recent changes
Milestone

Comments

@mp2019
Copy link

mp2019 commented Apr 11, 2019

Given an example class:

package com.test.app;

/**
 * Provide access to the service.
 */
public class Login {

        /** Perform the loging
         *
         * @param name user name
         * @param password user password
         */
        public void login(String name, String password) {
        }

}

for configuration:

task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
	outputFormat = 'javadoc'
}

The output param descriptions contains not expected characters:

public void login(java.lang.String name,
                  java.lang.String password)

Perform the loging

Parameters:
    name - org.jetbrains.dokka.NodeRenderContent@1f2d9c1d: user name
    password - org.jetbrains.dokka.NodeRenderContent@775ef0fa: user password 

Dokka version: 0.9.18

@cclover
Copy link

cclover commented Apr 24, 2019

I have met the same issue for java class. The kotlin class show normally.

@GCoder12
Copy link

I'm having the same issue on latest version of Dokka, 0.9.18

@semoro semoro added the regression An issue/bug that appeared after recent changes label May 16, 2019
@semoro semoro added this to the 0.9.19 milestone May 16, 2019
@semoro semoro added the format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general label May 16, 2019
@KrystianUjma KrystianUjma self-assigned this May 20, 2019
KrystianUjma pushed a commit to KrystianUjma/dokka that referenced this issue May 23, 2019
@KrystianUjma
Copy link
Contributor

I fixed it and pushed on multiplatform branch. Will be released in 0.9.19.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general regression An issue/bug that appeared after recent changes
Projects
None yet
Development

No branches or pull requests

5 participants