Skip to content

Fix javadoc warnings #1566

Closed as not planned
Closed as not planned
@php-coder

Description

@php-coder
$ ./mvnw javadoc:javadoc
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------< ru.mystamps:mystamps >------------------------
[INFO] Building My Stamps 0.4.7-SNAPSHOT
[INFO] --------------------------------[ war ]---------------------------------
[INFO]
[INFO] >>> maven-javadoc-plugin:3.4.0:javadoc (default-cli) > generate-sources @ mystamps >>>
[INFO]
[INFO] --- maven-enforcer-plugin:3.0.0-M3:enforce (enforce-banned-dependencies) @ mystamps ---
[INFO]
[INFO] <<< maven-javadoc-plugin:3.4.0:javadoc (default-cli) < generate-sources @ mystamps <<<
[INFO]
[INFO]
[INFO] --- maven-javadoc-plugin:3.4.0:javadoc (default-cli) @ mystamps ---
[INFO] No previous run data found, generating javadoc.
[INFO]
21 warnings
[WARNING] Javadoc Warnings
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/common/JdbcUtils.java:55: warning: no @param for resultSet
[WARNING] public static Currency getCurrency(ResultSet resultSet, String fieldName) throws SQLException {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/common/JdbcUtils.java:55: warning: no @param for fieldName
[WARNING] public static Currency getCurrency(ResultSet resultSet, String fieldName) throws SQLException {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/common/JdbcUtils.java:55: warning: no @return
[WARNING] public static Currency getCurrency(ResultSet resultSet, String fieldName) throws SQLException {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/common/JdbcUtils.java:55: warning: no @throws for java.sql.SQLException
[WARNING] public static Currency getCurrency(ResultSet resultSet, String fieldName) throws SQLException {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/support/beanvalidation/ConstraintViolationUtils.java:30: warning: no @param for ctx
[WARNING] public static void recreate(
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/support/beanvalidation/ConstraintViolationUtils.java:30: warning: no @param for fieldName
[WARNING] public static void recreate(
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/support/beanvalidation/ConstraintViolationUtils.java:30: warning: no @param for msgTemplate
[WARNING] public static void recreate(
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/support/beanvalidation/ConstraintViolationUtils.java:44: warning: no @param for ctx
[WARNING] public static void recreate(ConstraintValidatorContext ctx, String msgTemplate) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/support/beanvalidation/ConstraintViolationUtils.java:44: warning: no @param for msgTemplate
[WARNING] public static void recreate(ConstraintValidatorContext ctx, String msgTemplate) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/support/spring/security/SecurityContextUtils.java:35: warning: no @param for authority
[WARNING] public static boolean hasAuthority(GrantedAuthority authority) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/support/spring/security/SecurityContextUtils.java:35: warning: no @return
[WARNING] public static boolean hasAuthority(GrantedAuthority authority) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/support/spring/security/SecurityContextUtils.java:47: warning: no @return
[WARNING] public static Integer getUserId() {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/series/CatalogUtils.java:65: warning: no @param for catalogNumbers
[WARNING] public static String toShortForm(String catalogNumbers) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/series/CatalogUtils.java:65: warning: no @return
[WARNING] public static String toShortForm(String catalogNumbers) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/series/CatalogUtils.java:72: warning: no @param for catalogNumbers
[WARNING] public static String toShortForm(Collection<String> catalogNumbers) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/series/CatalogUtils.java:72: warning: no @return
[WARNING] public static String toShortForm(Collection<String> catalogNumbers) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/series/CatalogUtils.java:120: warning: no @param for catalogNumbers
[WARNING] public static Set<String> parseCatalogNumbers(String catalogNumbers) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/series/CatalogUtils.java:120: warning: no @return
[WARNING] public static Set<String> parseCatalogNumbers(String catalogNumbers) {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/series/importing/extractor/SeriesInfo.java:53: warning: no @return
[WARNING] public boolean isEmpty() {
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/site/SiteController.java:86: warning: no @param for pageNum
[WARNING] public void viewSiteEvents(
[WARNING] ^
[WARNING] /Users/coder/git/mystamps/src/main/java/ru/mystamps/web/feature/site/SiteController.java:86: warning: no @param for model
[WARNING] public void viewSiteEvents(
[WARNING] ^
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------

Metadata

Metadata

Assignees

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions