NVIDIA / NVIDIA/cudf

[BUG] Warnings generated during Javadoc build

Open
#8,854 1 comment 0 reactions 0 assignees View on GitHub
bug Java
Dominant language
C++
Stars
9.8k
Forks
1.1k
Avg merge
3d 6m
Merged PRs (30d)
278

Description

**Describe the bug**
When building Javadoc for the cudf Java bindings the following warnings are generated:
```
7 warnings
[WARNING] Javadoc Warnings
[WARNING] /home/jlowe/src/cudf/java/src/main/java/ai/rapids/cudf/ColumnView.java:2652: warning - @note: is an unknown tag.
[WARNING] /home/jlowe/src/cudf/java/src/main/java/ai/rapids/cudf/HostColumnVector.java:248: warning - Tag @see: can't find build(int, Consumer) in ai.rapids.cudf.HostColumnVector
[WARNING] /home/jlowe/src/cudf/java/src/main/java/ai/rapids/cudf/HostColumnVector.java:260: warning - Tag @see: can't find build(int, int, Consumer) in ai.rapids.cudf.HostColumnVector
[WARNING] /home/jlowe/src/cudf/java/src/main/java/ai/rapids/cudf/HostColumnVector.java:248: warning - Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
[WARNING] /home/jlowe/src/cudf/java/src/main/java/ai/rapids/cudf/HostColumnVector.java:248: warning - Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
[WARNING] /home/jlowe/src/cudf/java/src/main/java/ai/rapids/cudf/HostColumnVector.java:260: warning - Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
[WARNING] /home/jlowe/src/cudf/java/src/main/java/ai/rapids/cudf/HostColumnVector.java:260: warning - Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
```

**Steps/Code to reproduce bug**
```shell
$ cd cudf/java
$ mvn javadoc:javadoc
```

**Expected behavior**
There should be no warnings during a Javadoc build

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.