akka/akka-http

Fix scaladoc and javadoc references

Offen

#546 geöffnet am 18.11.2016

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Scala (598 Forks)batch import
1 - triagedhelp wantedt:docs

Repository-Metriken

Stars
 (1.311 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1T 10h) (2 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Ermitteln Sie ungelöste Methoden und Klassenreferenzen in scaladoc durch Ausführen von sbt unidoc und aktualisieren Sie dann die scaladoc Links, um auf die richtigen Mitglieder zu verweisen.
Tech Stack
Keine
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Scalasbt
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70