swagger-api/swagger-codegen

[JAVA] Javadoc backslash escape issue

Open

#6.240 geöffnet am 4. Aug. 2017

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Client: JavaFeature: DocumentationIssue: Bughelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Verfolgen Sie den Codegenerierungspfad für Modellbeschreibungen, um zu verstehen, wie Escape Sequenzen verarbeitet werden.
Tech Stack
java
Domain
backendapidocumentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Javaswagger codegen
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60