akka/akka-core

Issues importing docs into Dash

Open

#18,774 opened on Oct 25, 2015

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wantedt:build

Description

This is a continuation of https://github.com/akka/akka/issues/17860.

Dash generates the docsets by downloading the javadoc.jar and indexing it.

While generating docsets for akka-streams one of the following issues occurs:

  • The docs aren't there. Some of the packages just have a MANIFEST.MF file inside their javadoc.jar, and nothing else, so there's nothing to generate.
  • The docs aren't generated using scaladoc, but instead with javadoc. For example, com.typesafe.akka:akka-stream-experimental_2.11 has the docs generated with javadoc. When something is installed from "Scala Docsets", it expects to find scaladoc not javadoc docs. As a workaround docsets for these packages can be installed from "Java Docsets".

I don't understand much about Akka/Scala and so on, so I'm most likely missing something, but why are you generating the docs using javadoc and not scaladoc? Is this something that is common for Akka and I should support it on my end?

Contributor guide

Tech stack
scalajava
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
ScalaAkkaScaladocSBT
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate the build configuration for akka streams to determine why javadoc is used for some packages instead of scaladoc. Check the SBT build definitions and the plugin responsible for generating javadoc jars. Review the comments in referenced issue #17860 for context. Propose a change to ensure scaladoc is used for Scala packages.