swagger-api/swagger-codegen

[JAVA] Javadoc backslash escape issue

Open

#6.240 aberto em 4 de ago. de 2017

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)HTML (5.474 forks)batch import
Client: JavaFeature: DocumentationIssue: Bughelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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 .

Guia do colaborador

Direção de pesquisa
Trace o caminho de geração de código para descrições de modelo para entender como as sequências de escape são processadas.
Pilha de tecnologia
java
Domain
backendapidocumentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Javaswagger codegen
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60