swagger-api/swagger-codegen

[JAVA] Javadoc backslash escape issue

Open

#6240 aperta il 4 ago 2017

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)HTML (5474 fork)batch import
Client: JavaFeature: DocumentationIssue: Bughelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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 .

Guida contributor

Direzione di ricerca
Traccia il percorso di generazione del codice per le descrizioni del modello per capire come vengono elaborate le sequenze di escape.
Tech stack
java
Dominio
backendapidocumentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Javaswagger codegen
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60