akka/akka-core

Issues importing docs into Dash

Aberta

#18.774 aberto em 25 de out. de 2015

 (8 comentários) (0 reação) (0 responsável)Scala (3.547 forks)batch import
1 - triagedhelp wantedt:build

Métricas do repositório

Stars
 (13.277 estrelas)
Métricas de merge de PR
 (Mesclagem média 8d 19h) (10 fundiu PRs em 30d)

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?

Guia do colaborador