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

Wrong name of parameter in KDoc #8

Open
vsouhrada opened this issue Feb 7, 2020 · 0 comments
Open

Wrong name of parameter in KDoc #8

vsouhrada opened this issue Feb 7, 2020 · 0 comments
Assignees
Labels
bug Something isn't working
Milestone

Comments

@vsouhrada
Copy link
Collaborator

vsouhrada commented Feb 7, 2020

When using and additional property "removeMinusTextInHeaderProperty" to true then a name of header parameter in function is correct. Wrong is name of parameter in a function documentation

 /**
     * Service that returns maps.
     * Returns a list of maps.
     * @param xminusCallMinusChainMinusId  
     * @param xminusExecutionMinusTimeStamp  
     * @param xminusReleaseMinusVersion  
     * @return MapItemDto
     */
    @GET("/v1/mapitem/{mapItemId}")
    fun getMapItem(@Header("X-Call-Chain-Id") xCallChainId: kotlin.String, @Header("X-Execution-TimeStamp") xExecutionTimeStamp: kotlin.String, @Header("X-Release-Version") xReleaseVersion: kotlin.String)

Expected generated documentation is

 /**
     * Service that returns maps.
     * Returns a list of maps.
     * @param xCallChainMinusId  
     * @param xExecutionTimeStamp  
     * @param xReleaseVersion  
     * @return MapItemDto
     */
@vsouhrada vsouhrada added the bug Something isn't working label Feb 7, 2020
@vsouhrada vsouhrada added this to the 2.0.0 milestone Feb 7, 2020
@vsouhrada vsouhrada self-assigned this Feb 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant