scaladoc

How to generate type hierarchy diagrams with Scaladoc?

由 本秂侑毒 提交于 2019-12-18 04:01:32
问题 I want that Scaladoc generates a type hierarchy diagram for the following code snippet: trait A trait B extends A But when I execute scaladoc <file>.scala there is no type hierarchy shown - neither in A nor in B . How can I generate such diagrams? 回答1: First, one needs Scaladoc2 for this, which is part of Scala 2.10. If 2.10 is installed, one also needs to pass the -diagrams option to Scaladoc in order to generate the diagrams. But if you do so it can be that the following error message

How to generate type hierarchy diagrams with Scaladoc?

由 天涯浪子 提交于 2019-12-18 04:01:02
问题 I want that Scaladoc generates a type hierarchy diagram for the following code snippet: trait A trait B extends A But when I execute scaladoc <file>.scala there is no type hierarchy shown - neither in A nor in B . How can I generate such diagrams? 回答1: First, one needs Scaladoc2 for this, which is part of Scala 2.10. If 2.10 is installed, one also needs to pass the -diagrams option to Scaladoc in order to generate the diagrams. But if you do so it can be that the following error message

Can I use sbt's `apiMappings` setting for managed dependencies?

由 五迷三道 提交于 2019-12-17 18:47:40
问题 I'd like the ScalaDoc I generate with sbt to link to external libraries, and in sbt 0.13 we have autoAPIMappings which is supposed to add these links for libraries that declare their apiURL . In practice though, none of the libraries I use provide this in their pom/ivy metadata, and I suspect some of these libraries will never do so. The apiMappings setting is supposed to help with just that, but it is typed as Map[File, URL] and hence geared towards setting doc urls for unmanaged

Autogenerated documentation for a mixed java/scala project

由 只愿长相守 提交于 2019-12-12 09:47:17
问题 I'd love some advice on how best to autogenerate documentation for a mixed Java/Scala project. We're using Scala 2.8; it seems the scaladoc tool that ships with 2.8.1 does not generate usable documentation for our Java classes -- it gets the structure right, but does not include the documentation. And javadoc obviously only covers the Java part. We looked at Doxygen, but it doesn't work with Scala out of the box, so that's a bit of a research project. How can we do this short of going 100%

Setting up Javadoc for Scala projects in IntelliJ

由 我与影子孤独终老i 提交于 2019-12-07 12:53:33
问题 After setting up my Scaladoc, i see that some documentation is still missing from the IDE It seems to me (many thanks to Peter for noticing this) that: functions with non-bold font have no documentation functions with bold font have bare minimum underlined functions have complete documentation No documentation (normal non-bold font) Bare minimum documentation (bold) Complete documentation (underlined) For the record, my scaladoc is installed as follows doc ├── scala-devel-docs │ └── api │ ├──

Scaladoc (2.11.6) fails on throws tag with “unable to find any member to link”

由 南楼画角 提交于 2019-12-06 20:51:17
问题 When attempting to publish the jars for my project via sbt "++2.11.6 publishLocal" or sbt +publishLocal , I encounter Scaladoc issues when publishing for Scala 2.11.6. It appears that I have invalid links caused by the @throws tag. I am not sure why I have invalid links nor why the error only occurs for Scala 2.11.6 while not for Scala 2.10.5 during my cross-publishing. I can't find any indication that the @throws tag is not supported on Scala 2.11; so, I'm assuming it is an issue with my

Setting up Javadoc for Scala projects in IntelliJ

由 三世轮回 提交于 2019-12-06 03:39:43
After setting up my Scaladoc, i see that some documentation is still missing from the IDE It seems to me (many thanks to Peter for noticing this) that: functions with non-bold font have no documentation functions with bold font have bare minimum underlined functions have complete documentation No documentation (normal non-bold font) Bare minimum documentation (bold) Complete documentation (underlined) For the record, my scaladoc is installed as follows doc ├── scala-devel-docs │ └── api │ ├── index │ ├── lib │ └── scala │ ├── actors │ │ ├── remote │ │ └── scheduler │ ├── annotation │ │ ├──

Autogenerated documentation for a mixed java/scala project

由 你说的曾经没有我的故事 提交于 2019-12-05 20:13:21
I'd love some advice on how best to autogenerate documentation for a mixed Java/Scala project. We're using Scala 2.8; it seems the scaladoc tool that ships with 2.8.1 does not generate usable documentation for our Java classes -- it gets the structure right, but does not include the documentation. And javadoc obviously only covers the Java part. We looked at Doxygen, but it doesn't work with Scala out of the box, so that's a bit of a research project. How can we do this short of going 100% Java or 100% Scala? Thanks! Play Framework generates scaladoc for its Scala classes and javadoc for its

SBT Scaladoc Configuration

由 ∥☆過路亽．° 提交于 2019-12-05 01:21:45
I'm trying to configure the Scaladoc in SBT, specifically the title, output directory and classpath. I managed to define the title by adding the following to build.sbt: scalacOptions in (Compile, doc) ++= Opts.doc.title("Scala-Tools") I can't figure out how to change the doc output directory. I also can't figure out how to add jars to classpath. The reason I want to edit the classpath is because it appears the standard Scala library is not getting picked up by scaladoc when I refer to its classes, i.e. [[scala.Option]] leads to a warning "Could not find any member to link for "scala.Option"."

Scaladoc (2.11.6) fails on throws tag with “unable to find any member to link”

由 大城市里の小女人 提交于 2019-12-05 00:45:12
When attempting to publish the jars for my project via sbt "++2.11.6 publishLocal" or sbt +publishLocal , I encounter Scaladoc issues when publishing for Scala 2.11.6. It appears that I have invalid links caused by the @throws tag. I am not sure why I have invalid links nor why the error only occurs for Scala 2.11.6 while not for Scala 2.10.5 during my cross-publishing. I can't find any indication that the @throws tag is not supported on Scala 2.11; so, I'm assuming it is an issue with my Scaladoc, but I don't know what I am missing at this point. Can anyone give me some insight into this
订阅 scaladoc