swagger-api/swagger-codegen

[JAVA] Javadoc backslash escape issue

Open

#6 240 ouverte le 4 août 2017

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)HTML (5 474 forks)batch import
Client: JavaFeature: DocumentationIssue: Bughelp wanted

Métriques du dépôt

Stars
 (12 701 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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 .

Guide contributeur

Direction de recherche
Tracez le chemin de generation de code pour les descriptions de modele afin de comprendre comment les sequences d'echappement sont traitees.
Stack technique
java
Domaine
backendapidocumentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Javaswagger codegen
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60