akka/akka-http

Fix scaladoc and javadoc references

Aberta

#546 aberto em 18 de nov. de 2016

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Métricas do repositório

Stars
 (1.311 estrelas)
Métricas de merge de PR
 (Mesclagem média 1d 10h) (2 fundiu PRs em 30d)

Description

There are several method and class references in the scaladoc which are unresolved and generate 97 warnings of the kind Could not find any member to link for "XYZ" when running sbt unidoc. It would be nice to fix the references to improve the scaladoc.

The warnings are likely also the reason why javadoc linting had to be disabled in #501. Once the above scaladoc errors have been resolved, the goal will be to get the following command to succeed after reverting #501:

sbt -Dakka.genjavadoc.enabled=true genjavadoc:doc

Guia do colaborador

Direção de pesquisa
Identifique referências não resolvidas de métodos e classes no scaladoc executando sbt unidoc e atualize os links do scaladoc para apontar para os membros corretos.
Pilha de tecnologia
None
Domain
backend
Tipo Issue
Documentação
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.
Meio dia
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
Scalasbt
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70