Merge pull request #42 from NthPortal/fix-docs

Fix scaladocs
NthPortal · Sep 13, 2020 · 249dbda · 249dbda
2 parents 285fb82 + 451426c
commit 249dbda
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -14,7 +14,7 @@ env:
 before_install:
   - git fetch --tags
 
-script: sbt ++$TRAVIS_SCALA_VERSION coverage test mimaReportBinaryIssues scalafmtCheckAll scalafmtSbtCheck
+script: sbt ++$TRAVIS_SCALA_VERSION coverage test mimaReportBinaryIssues scalafmtCheckAll scalafmtSbtCheck doc
 
 after_success:
   - sbt ++$TRAVIS_SCALA_VERSION coverageAggregate coveralls

diff --git a/core/src/main/scala/lgbt/princess/v/Variable.scala b/core/src/main/scala/lgbt/princess/v/Variable.scala
@@ -26,7 +26,7 @@ object Variable extends VersionFactory[Variable] with VersionFactory.Unconstrain
    * Creates a [[Variable variable-sized version]] with the specified
    * [[Variable.seq sequence]] of values.
    *
-   * @throws IllegalArgumentException if the sequence of values is empty
+   * @throws scala.IllegalArgumentException if the sequence of values is empty
    */
   @throws[IllegalArgumentException]
   def apply(seq: IndexedSeq[Int]): Variable = unsafeFromSeq(seq)
@@ -35,7 +35,7 @@ object Variable extends VersionFactory[Variable] with VersionFactory.Unconstrain
    * Creates a [[Variable variable-sized version]] with the specified
    * values as its [[Variable.seq sequence]].
    *
-   * @throws IllegalArgumentException if no values are given
+   * @throws scala.IllegalArgumentException if no values are given
    */
   @throws[IllegalArgumentException]
   def apply(values: Int*): Variable = apply(values.toIndexedSeq)

diff --git a/semver/src/main/scala/lgbt/princess/v/semver/Core.scala b/semver/src/main/scala/lgbt/princess/v/semver/Core.scala
@@ -44,7 +44,7 @@ final case class Core(major: Int, minor: Int, patch: Int) extends Version with O
   /**
    * @return a pre-release SemVer version with the given identifiers
    *         to which build identifiers can be added using the
-   *         [[SemVerPreReleaseIntermediate.+ `+`]] operator.
+   *         [[Core.SemVerPreReleaseIntermediate.+ `+`]] operator.
    */
   def -(preRelease: PreRelease): SemVerPreReleaseIntermediate =
     new SemVerPreReleaseIntermediate(SemVer(this, preRelease))

diff --git a/semver/src/main/scala/lgbt/princess/v/semver/Identifiers.scala b/semver/src/main/scala/lgbt/princess/v/semver/Identifiers.scala
@@ -75,8 +75,8 @@ object Identifiers {
     /**
      * @param values the string values of the identifiers
      * @return identifiers of this factory's type from a sequence of strings
-     * @throws IllegalArgumentException if the any of the identifiers were not valid
-     *                                  for this factory's type
+     * @throws scala.IllegalArgumentException if the any of the identifiers were not valid
+     *                                        for this factory's type
      */
     @throws[IllegalArgumentException]
     final def unsafeFrom(values: Seq[String]): I =
@@ -86,8 +86,8 @@ object Identifiers {
     /**
      * @param values the string values of the identifiers
      * @return identifiers of this factory's type from a sequence of strings
-     * @throws IllegalArgumentException if the any of the identifiers were not valid
-     *                                  for this factory's type
+     * @throws scala.IllegalArgumentException if the any of the identifiers were not valid
+     *                                        for this factory's type
      */
     @throws[IllegalArgumentException]
     @inline final def apply(values: String*): I = unsafeFrom(values)
@@ -107,8 +107,8 @@ object Identifiers {
     /**
      * @param identifiers the string representing the identifiers
      * @return identifiers of this factory's type from the string
-     * @throws IllegalArgumentException if the string did not represent valid
-     *                                  identifiers of this factory's type
+     * @throws scala.IllegalArgumentException if the string did not represent valid
+     *                                        identifiers of this factory's type
      */
     @throws[IllegalArgumentException]
     final def unsafeParse(identifiers: String): I = {