Skip to content

Commit ff33b77

Browse files
committed
Fix scaladoc errors
1 parent 2abd9e6 commit ff33b77

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

build.sbt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ def versionedScalacOptions(scalaVersion: String) = {
1515
})
1616
}
1717

18+
def apiUrl(name: String) = Some(url(s"https://lucidsoftware.github.io/xtract/$name/api/"))
19+
1820
inThisBuild(Seq(
1921
credentials += Credentials("Sonatype Nexus Repository Manager", "oss.sonatype.org", System.getenv("SONATYPE_USERNAME"), System.getenv("SONATYPE_PASSWORD")),
2022
developers ++= List(
@@ -27,6 +29,7 @@ inThisBuild(Seq(
2729
scmInfo := Some(ScmInfo(url("https://github.com/lucidsoftware/xtract"), "scm:git:git@github.com:lucidsoftware/xtract.git")),
2830
version := sys.props.getOrElse("build.version", "0-SNAPSHOT"),
2931
sonatypeSessionName := s"[sbt-sonatype] xtract-${scalaBinaryVersion.value}-${version.value}",
32+
autoAPIMappings := true,
3033
))
3134

3235
lazy val commonSettings = Seq(
@@ -49,6 +52,7 @@ lazy val xtract = (projectMatrix in file("xtract-core"))
4952
name := "xtract",
5053
commonSettings,
5154
description := "Library to deserialize Xml to user types.",
55+
apiURL := apiUrl("core"),
5256
libraryDependencies ++= catsDependency ++ Seq(
5357
"org.scala-lang.modules" %% "scala-xml" % "1.3.0",
5458
"org.scala-lang.modules" %% "scala-collection-compat" % "2.3.2"
@@ -62,6 +66,7 @@ lazy val xtractMacros = (projectMatrix in file("macros"))
6266
name := "xtract-macros",
6367
commonSettings,
6468
description := "Macros for creating XmlReaders.",
69+
apiURL := apiUrl("macros"),
6570
libraryDependencies += "org.scala-lang" % "scala-reflect" % scalaVersion.value
6671
)
6772
.jvmPlatform(scalaVersions = scalaVersions)
@@ -72,6 +77,7 @@ lazy val xtractTesting = (projectMatrix in file("testing"))
7277
name := "xtract-testing",
7378
commonSettings,
7479
description := "Specs2 matchers for xtract.",
80+
apiURL := apiUrl("testing"),
7581
libraryDependencies ++= specs2Dependency
7682
)
7783
.jvmPlatform(scalaVersions = scalaVersions)

macros/src/main/scala/com/lucidchart/open/xtract/meta/package.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import scala.language.experimental.macros
44

55
package object meta {
66
/**
7-
* Define an [[XmlReader]] for type `A` from a list of [[ReadParam]]s.
8-
* @tparam A The type to create the [[XmlReader]] for.
7+
* Define an [[com.lucidchart.open.xtract.XmlReader]] for type `A` from a list of [[ReadParam]]s.
8+
* @tparam A The type to create the [[com.lucidchart.open.xtract.XmlReader]] for.
99
* @param lines A list of [[ReadParam]]s describe the fields to parse. These should correspond to
1010
* the parameters for one of the constructors of `A`. There should be an implicit [[XmlReader]] in
1111
* scope for the type of each [[ReadParam]].

0 commit comments

Comments
 (0)