aws-cloudformation / aws-cloudformation/cloudformation-cli-java-plugin

Javadoc isn't delomboked

Aberta
#234 1 comentário 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Java
Estrelas
30
Forks
48
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

The documentation generated by `mvn javadoc:javadoc` is missing the methods auto-generated by Lombok. So, the documentation is missing methods like `builder()` that are used in our examples.

There's a [Maven plugin](http://anthonywhitford.com/lombok.maven/lombok-maven-plugin/index.html) that helps. I've tried it and it seems to work. The steps are:

1. Moving the source code from `src/main/java` to `src/main/lombok`
2. Adding the following stanza to `pom.xml`:

```xml

org.projectlombok
lombok-maven-plugin
1.18.10.0


generate-sources

delombok




```

After that, the javadoc goal produces the full documentation.

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Revise os fontes Java em src/main/java e a configuração de build em pom.xml e, em seguida, compare a saída atual do Maven Javadoc com os métodos builder() documentados. Investigue a configuração proposta de delombok do lombok-maven-plugin e verifique se mvn javadoc:javadoc produz uma documentação contendo os métodos gerados.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
java
Domínio
build-system, documentation
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.