swagger-api/swagger-codegen

[JAVA] Javadoc backslash escape issue

Open

#6240 opened on Aug 4, 2017

View on GitHub
 (1 comment) (1 reaction) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: JavaFeature: DocumentationIssue: Bughelp wanted

Description

Description

When codegen renders a method description into a Javadoc comment it seems to not correctly remove \"escapes.

Sample

"description":"Test\nRequires user permission: \"system.variables-rest:view\"."

Result:

     * Test  Requires user permission: \"system.variables-rest:view\".

It does not preserve the linebreaks and it does preserve the \

Swagger-codegen version

2.2.3

Swagger declaration file content or url
    "description":"Test\nRequires user permission: \"system.variables-rest:view\"."
Command line used for generation
java -jar ... generate -l java -i swagger.json -o .

Contributor guide

Tech stack
java
Domain
documentationtooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Java knowledgeUnderstanding of Javadoc syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate how the swagger codegen renders method descriptions into Javadoc comments. Check the template files (e.g., Java pojo or api.mustache) and the codegen logic that processes description strings. Focus on the escaping of backslashes and quotes. The issue reports that `\` and `"` are not handled correctly. Look for the method that generates the Javadoc comment and see how it escapes special characters. Also check if there are existing tests for Javadoc generation.