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 (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wanted

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

Tech stack
scala
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ScalaSBT build tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how to configure Scaladoc to link to Java standard library Javadoc. The file akka actor/src/main/scala/akka/io/Inet.scala contains a linking warning for java.net.Socket#setSendBufferSize. Check the build.sbt for Scaladoc options and consider adding a javadoc base flag or ensuring the Java documentation path is correctly set. Also verify if similar warnings exist in other files.