akka/akka-core

Scaladoc warnings when generating docs locally - unable to link to Javadoc

Open

#19,998 opened on Mar 10, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wanted

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

There is a number of warnings that appear when running sbt doc locally that are not logged on jenkins, for example:

[warn] /home/w/projects/akka/akka-actor/src/main/scala/akka/io/Inet.scala:120: Could not find any member to link for "java.net.Socket#setSendBufferSize".

This warning basically means that it's unable to find Java class, and in the result the link is not clickable.

The link is not clickable both on the published documentation and in my locally produced version

Contributor guide

Research direction
Check the Scaladoc configuration in build.sbt for external Javadoc links and verify the Java version used.
Tech stack
scala
Domain
documentationtooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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.
Mostly clear
Prerequisites
Scalasbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80