Skip to content

Commit

Permalink
No javadoc please; document new feature (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
ennru authored Sep 11, 2019
2 parents 235a1a2 + 7da14c2 commit 3843ba7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@ import com.lightbend.paradox.apidoc.ApidocPlugin.autoImport.apidocRootPackage
(...)
```

### When only Scaladoc is generated

If the project does not publish Javadoc, the corresponding Javadoc base URL can be cleared and the Java links will point to the `javadsl` package in the Scaladocs.

Example:
```scala
"javadoc.akka.stream.alpakka.base_url" -> ""
```

## License

The license is Apache 2.0, see LICENSE.
Expand Down
9 changes: 6 additions & 3 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ libraryDependencies ++= Seq(
Library.scalatest % Test
)

licenses += ("Apache-2.0", url("http://www.apache.org/licenses/LICENSE-2.0"))
licenses += ("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0"))
homepage := Some(url("https://github.com/lightbend/sbt-paradox-apidoc"))
scmInfo := Some(
ScmInfo(url("https://github.com/lightbend/sbt-paradox-apidoc"), "[email protected]:lightbend/sbt-paradox-apidoc.git")
Expand All @@ -25,8 +25,9 @@ developers += Developer(
"https://gitter.im/lightbend/paradox",
url("https://github.com/lightbend/sbt-paradox-apidoc/graphs/contributors")
)
organizationName := "Lightbend Inc."
startYear := Some(2018)
organizationName := "Lightbend Inc."
organizationHomepage := Some(url("https://lightbend.com"))
startYear := Some(2018)

bintrayOrganization := Some("sbt")
bintrayRepository := "sbt-plugin-releases"
Expand All @@ -39,3 +40,5 @@ scriptedLaunchOpts += ("-Dproject.version=" + version.value)
scriptedLaunchOpts ++= java.lang.management.ManagementFactory.getRuntimeMXBean.getInputArguments.asScala.filter(
a => Seq("-Xmx", "-Xms", "-XX", "-Dfile").exists(a.startsWith)
)

packageSrc / publishArtifact := false

0 comments on commit 3843ba7

Please sign in to comment.