Javadoc isn't delomboked
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Bug
- Clareza
- Claramente especificada
- Status de atividade
- Estagnada
- Stack de tecnologia
- java
- Domínio
- build-system, documentation
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.
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 that helps. I've tried it and it seems to work. The steps are:
- Moving the source code from
src/main/javatosrc/main/lombok - Adding the following stanza to
pom.xml:
<plugin>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-maven-plugin</artifactId>
<version>1.18.10.0</version>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>delombok</goal>
</goals>
</execution>
</executions>
</plugin>
After that, the javadoc goal produces the full documentation.
- Linguagem predominante
- Java
- Estrelas
- 30
- Forks
- 48
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de aws-cloudformation/cloudformation-cli-java-plugin
-
Runtime compatibility issueAberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 25/100
aws-cloudformation/cloudformation-cli-java-plugin#415 · 1 comentário ·
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 42/100
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 20/100
-
injectCredentialsAndInvokeV2 method in proxy class doesn't support API's like PutObject from S3.Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
Todas as issues de aws-cloudformation/cloudformation-cli-java-plugin
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
objectionary/hone-maven-plugin#1295 ·
Mantenedores costumam responder em até 1 dia
-
Clarify Javadoc for Logger methods taking Object... arguments with regards to Throwable detectionAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 88/100
-
enhancement good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
Mantenedores costumam responder em até 1 dia
-
[Bug] The shared instance selector's placeholder and no-match text ignore the display languageTalvez já em andamento Um pull request vinculado a esta issue está aberto ou já foi mesclado. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 90/100
apache/rocketmq-dashboard#5561 ·
Mantenedores costumam responder em até 3 dias