akka/akka-http

Fix scaladoc and javadoc references

Open

#546 opened on Nov 18, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 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

Contributor guide

Research direction
Identify unresolved method and class references in scaladoc by running sbt unidoc, then update the scaladoc links to point to the correct members.
Tech stack
None
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Scalasbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70