Skip to content

Commit 48dfa61

Browse files
committed
Fix linking in scaladoc
1 parent 1507646 commit 48dfa61

File tree

2 files changed

+44
-30
lines changed

2 files changed

+44
-30
lines changed

core/src/main/scala/org/polars/scala/polars/api/Series.scala

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,30 @@ class Series private (private[polars] val ptr: Long) {
1111

1212
object Series {
1313

14-
/** Initialize new series by name and values of type [[Int]].
14+
/** Initialize new series by name and values of type [[scala.Int]].
1515
*
1616
* @param name
1717
* Name of Series
1818
* @param values
1919
* Values of Series as a scala or java array
2020
*
2121
* @return
22-
* Series of type [[Int]]. If `values` is empty, empty series is returned retaining type.
22+
* Series of type [[scala.Int]]. If `values` is empty, empty series is returned retaining
23+
* type.
2324
*/
2425
def ofInt(name: String, values: Array[Int]): Series =
2526
Series.withPtr(series.new_int_series(name, values))
2627

27-
/** Initialize new series by name and values of type [[Int]].
28+
/** Initialize new series by name and values of type [[scala.Int]].
2829
*
2930
* @param name
3031
* Name of Series
3132
* @param values
3233
* Values of Series as a scala iterable
3334
*
3435
* @return
35-
* Series of type [[Int]]. If `values` is empty, empty series is returned retaining type.
36+
* Series of type [[scala.Int]]. If `values` is empty, empty series is returned retaining
37+
* type.
3638
*/
3739
def ofInt(name: String, values: Iterable[Int]): Series = Series.ofInt(name, values.toArray)
3840

@@ -64,28 +66,30 @@ object Series {
6466
def ofInt(name: String, values: java.lang.Iterable[java.lang.Integer]): Series =
6567
Series.ofInt(name, values.asScala.toArray)
6668

67-
/** Initialize new series by name and values of type [[Long]].
69+
/** Initialize new series by name and values of type [[scala.Long]].
6870
*
6971
* @param name
7072
* Name of Series
7173
* @param values
7274
* Values of Series as a scala or java array
7375
*
7476
* @return
75-
* Series of type [[Long]]. If `values` is empty, empty series is returned retaining type.
77+
* Series of type [[scala.Long]]. If `values` is empty, empty series is returned retaining
78+
* type.
7679
*/
7780
def ofLong(name: String, values: Array[Long]): Series =
7881
Series.withPtr(series.new_long_series(name, values))
7982

80-
/** Initialize new series by name and values of type [[Long]].
83+
/** Initialize new series by name and values of type [[scala.Long]].
8184
*
8285
* @param name
8386
* Name of Series
8487
* @param values
8588
* Values of Series as a scala iterable
8689
*
8790
* @return
88-
* Series of type [[Long]]. If `values` is empty, empty series is returned retaining type.
91+
* Series of type [[scala.Long]]. If `values` is empty, empty series is returned retaining
92+
* type.
8993
*/
9094
def ofLong(name: String, values: Iterable[Long]): Series = Series.ofLong(name, values.toArray)
9195

@@ -117,28 +121,30 @@ object Series {
117121
def ofLong(name: String, values: java.lang.Iterable[java.lang.Long]): Series =
118122
Series.ofLong(name, values.asScala.toArray)
119123

120-
/** Initialize new series by name and values of type [[Float]].
124+
/** Initialize new series by name and values of type [[scala.Float]].
121125
*
122126
* @param name
123127
* Name of Series
124128
* @param values
125129
* Values of Series as a scala or java array
126130
*
127131
* @return
128-
* Series of type [[Float]]. If `values` is empty, empty series is returned retaining type.
132+
* Series of type [[scala.Float]]. If `values` is empty, empty series is returned retaining
133+
* type.
129134
*/
130135
def ofFloat(name: String, values: Array[Float]): Series =
131136
Series.withPtr(series.new_float_series(name, values))
132137

133-
/** Initialize new series by name and values of type [[Float]].
138+
/** Initialize new series by name and values of type [[scala.Float]].
134139
*
135140
* @param name
136141
* Name of Series
137142
* @param values
138143
* Values of Series as a scala iterable
139144
*
140145
* @return
141-
* Series of type [[Float]]. If `values` is empty, empty series is returned retaining type.
146+
* Series of type [[scala.Float]]. If `values` is empty, empty series is returned retaining
147+
* type.
142148
*/
143149
def ofFloat(name: String, values: Iterable[Float]): Series =
144150
Series.ofFloat(name, values.toArray)
@@ -171,28 +177,30 @@ object Series {
171177
def ofFloat(name: String, values: java.lang.Iterable[java.lang.Float]): Series =
172178
Series.ofFloat(name, values.asScala.toArray)
173179

174-
/** Initialize new series by name and values of type [[Double]].
180+
/** Initialize new series by name and values of type [[scala.Double]].
175181
*
176182
* @param name
177183
* Name of Series
178184
* @param values
179185
* Values of Series as a scala or java array
180186
*
181187
* @return
182-
* Series of type [[Double]]. If `values` is empty, empty series is returned retaining type.
188+
* Series of type [[scala.Double]]. If `values` is empty, empty series is returned retaining
189+
* type.
183190
*/
184191
def ofDouble(name: String, values: Array[Double]): Series =
185192
Series.withPtr(series.new_double_series(name, values))
186193

187-
/** Initialize new series by name and values of type [[Double]].
194+
/** Initialize new series by name and values of type [[scala.Double]].
188195
*
189196
* @param name
190197
* Name of Series
191198
* @param values
192199
* Values of Series as a scala iterable
193200
*
194201
* @return
195-
* Series of type [[Double]]. If `values` is empty, empty series is returned retaining type.
202+
* Series of type [[scala.Double]]. If `values` is empty, empty series is returned retaining
203+
* type.
196204
*/
197205
def ofDouble(name: String, values: Iterable[Double]): Series =
198206
Series.ofDouble(name, values.toArray)
@@ -225,28 +233,30 @@ object Series {
225233
def ofDouble(name: String, values: java.lang.Iterable[java.lang.Double]): Series =
226234
Series.ofDouble(name, values.asScala.toArray)
227235

228-
/** Initialize new series by name and values of type [[Boolean]].
236+
/** Initialize new series by name and values of type [[scala.Boolean]].
229237
*
230238
* @param name
231239
* Name of Series
232240
* @param values
233241
* Values of Series as a scala or java array
234242
*
235243
* @return
236-
* Series of type [[Boolean]]. If `values` is empty, empty series is returned retaining type.
244+
* Series of type [[scala.Boolean]]. If `values` is empty, empty series is returned retaining
245+
* type.
237246
*/
238247
def ofBoolean(name: String, values: Array[Boolean]): Series =
239248
Series.withPtr(series.new_boolean_series(name, values))
240249

241-
/** Initialize new series by name and values of type [[Boolean]].
250+
/** Initialize new series by name and values of type [[scala.Boolean]].
242251
*
243252
* @param name
244253
* Name of Series
245254
* @param values
246255
* Values of Series as a scala iterable
247256
*
248257
* @return
249-
* Series of type [[Boolean]]. If `values` is empty, empty series is returned retaining type.
258+
* Series of type [[scala.Boolean]]. If `values` is empty, empty series is returned retaining
259+
* type.
250260
*/
251261
def ofBoolean(name: String, values: Iterable[Boolean]): Series =
252262
Series.ofBoolean(name, values.toArray)
@@ -279,28 +289,30 @@ object Series {
279289
def ofBoolean(name: String, values: java.lang.Iterable[java.lang.Boolean]): Series =
280290
Series.ofBoolean(name, values.asScala.toArray)
281291

282-
/** Initialize new series by name and values of type [[String]].
292+
/** Initialize new series by name and values of type [[java.lang.String]].
283293
*
284294
* @param name
285295
* Name of Series
286296
* @param values
287297
* Values of Series as a scala or java array
288298
*
289299
* @return
290-
* Series of type [[String]]. If `values` is empty, empty series is returned retaining type.
300+
* Series of type [[java.lang.String]]. If `values` is empty, empty series is returned
301+
* retaining type.
291302
*/
292303
def ofString(name: String, values: Array[String]): Series =
293304
Series.withPtr(series.new_str_series(name, values))
294305

295-
/** Initialize new series by name and values of type [[String]].
306+
/** Initialize new series by name and values of type [[java.lang.String]].
296307
*
297308
* @param name
298309
* Name of Series
299310
* @param values
300311
* Values of Series as a scala iterable
301312
*
302313
* @return
303-
* Series of type [[String]]. If `values` is empty, empty series is returned retaining type.
314+
* Series of type [[java.lang.String]]. If `values` is empty, empty series is returned
315+
* retaining type.
304316
*/
305317
def ofString(name: String, values: Iterable[String]): Series =
306318
Series.ofString(name, values.toArray)
@@ -452,17 +464,17 @@ object Series {
452464
def ofSeries(name: String, values: java.lang.Iterable[Series]): Series =
453465
Series.ofSeries(name, values.asScala.toArray)
454466

455-
/** Initialize new nested series by name and values of provided type [[T]].
467+
/** Initialize new nested series by name and values of provided type.
456468
*
457469
* @param name
458470
* Name of Series
459471
* @param values
460472
* Values of Series as a scala or java array
461473
*
462474
* @return
463-
* Nested Series of provided type [[T]]. If `values` is empty, empty series is returned
464-
* retaining type. Nested collections in `values` must not be empty or this will result in
465-
* [[ArrayIndexOutOfBoundsException]].
475+
* Nested Series of provided type. If `values` is empty, empty series is returned retaining
476+
* type. Nested collections in `values` must not be empty or this will result in
477+
* [[java.lang.ArrayIndexOutOfBoundsException]].
466478
*/
467479
def ofList[T](name: String, values: Array[Array[T]]): Series =
468480
Series.ofList(name, values.map(_.toSeq).toSeq)
@@ -477,7 +489,7 @@ object Series {
477489
* @return
478490
* Nested Series of provided type. If `values` is empty, empty series is returned retaining
479491
* type. Nested collections in `values` must not be empty or this will result in
480-
* [[ArrayIndexOutOfBoundsException]].
492+
* [[java.lang.ArrayIndexOutOfBoundsException]].
481493
*/
482494
def ofList(name: String, values: java.lang.Iterable[java.lang.Iterable[_]]): Series =
483495
JSeries.ofList(name, values)
@@ -492,7 +504,7 @@ object Series {
492504
* @return
493505
* Nested Series of provided type. If `values` is empty, empty series is returned retaining
494506
* type. Nested collections in `values` must not be empty or this will result in
495-
* [[ArrayIndexOutOfBoundsException]].
507+
* [[java.lang.ArrayIndexOutOfBoundsException]].
496508
*/
497509
def ofList(name: String, values: Iterable[Iterable[_]]): Series =
498510
Series.ofList(name, values.map(_.asJava.asInstanceOf[java.lang.Iterable[_]]).asJava)

project/plugins.sbt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ addSbtPlugin("com.github.sbt" % "sbt-dynver" % "5.0.1")
1717
addSbtPlugin("com.github.sbt" % "sbt-ghpages" % "0.8.0")
1818

1919
addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0")
20+
21+
addSbtPlugin("com.thoughtworks.sbt-api-mappings" % "sbt-api-mappings" % "3.0.2")

0 commit comments

Comments
 (0)