akka/akka-http

Fix scaladoc and javadoc references

Ouverte

#546 ouverte le 18 nov. 2016

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Métriques du dépôt

Stars
 (1 311 étoiles)
Métriques de merge PR
 (Merge moyen 1j 10h) (2 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Identifiez les références de méthodes et de classes non résolues dans scaladoc en exécutant sbt unidoc, puis mettez à jour les liens scaladoc pour pointer vers les bons membres.
Stack technique
Aucun
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Scalasbt
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70