akka/akka-http

Fix scaladoc and javadoc references

Aperta

#546 aperta il 18 nov 2016

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Scala (598 fork)batch import
1 - triagedhelp wantedt:docs

Metriche repository

Star
 (1311 stelle)
Metriche merge PR
 (Merge medio 1g 10h) (2 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Identifica i riferimenti a metodi e classi non risolti in scaladoc eseguendo sbt unidoc, quindi aggiorna i link scaladoc per puntare ai membri corretti.
Tech stack
Nessuno
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Scalasbt
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70