Skip to content

Wrong name of parameter in KDoc #8

@vsouhrada

Description

@vsouhrada

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
     */

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions