Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc Warnings in the Gradle plugin #29309

Closed
gastaldi opened this issue Nov 16, 2022 · 10 comments · Fixed by #36483
Closed

Javadoc Warnings in the Gradle plugin #29309

gastaldi opened this issue Nov 16, 2022 · 10 comments · Fixed by #36483
Labels
area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/gradle Gradle good first issue Good for newcomers kind/enhancement New feature or request
Milestone

Comments

@gastaldi
Copy link
Contributor

Description

While building Quarkus (using ./mvnw -B clean install -DskipTests -DskipITs -DskipDocs -Prelocations), I get the following warnings while building the Gradle plugin:

[INFO] --- exec-maven-plugin:3.0.0:exec (gradle) @ io.quarkus.gradle.plugin ---
To honour the JVM settings for this build a single-use Daemon process will be forked. See https://docs.gradle.org/7.5.1/userguide/gradle_daemon.html#sec:disabling_the_daemon.
Daemon will be stopped at the end of the build 
> Task :gradle-application-plugin:clean UP-TO-DATE
> Task :gradle-model:compileJava UP-TO-DATE
> Task :gradle-application-plugin:compileJava
> Task :gradle-application-plugin:pluginDescriptors
> Task :gradle-application-plugin:processResources
> Task :gradle-application-plugin:classes
> Task :gradle-application-plugin:jar
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/extension/QuarkusPluginExtension.java:141: warning: no @param for fileCollection
    public static File getLastFile(FileCollection fileCollection) {
> Task :gradle-application-plugin:javadoc
                       ^
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/extension/QuarkusPluginExtension.java:141: warning: no @return
    public static File getLastFile(FileCollection fileCollection) {
                       ^
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/tasks/QuarkusDev.java:131: warning: no @return
    public Configuration getQuarkusDevConfiguration() {
                         ^
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/tasks/QuarkusDev.java:141: warning: no @return
    public FileCollection getSources() {
                          ^
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/tasks/QuarkusDev.java:151: warning: no @return
    public FileCollection getCompilationOutput() {
                          ^
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/tasks/QuarkusDev.java:162: warning: no @return
    public Property<File> getWorkingDirectory() {
                          ^
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/tasks/QuarkusDev.java:170: warning: no @param for workingDir
    public void setWorkingDir(String workingDir) {
                ^
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/tasks/QuarkusDev.java:185: warning: no @return
    public boolean isPreventnoverify() {
                   ^
/home/runner/work/quarkus-prettytime/quarkus-prettytime/quarkus/devtools/gradle/gradle-application-plugin/src/main/java/io/quarkus/gradle/tasks/QuarkusDev.java:197: warning: no @param for preventNoVerify
    public void setPreventnoverify(boolean preventNoVerify) {
                ^
9 warnings

Implementation ideas

Fix the Javadoc warnings

@gastaldi gastaldi added kind/enhancement New feature or request good first issue Good for newcomers area/gradle Gradle area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins labels Nov 16, 2022
@quarkus-bot
Copy link

quarkus-bot bot commented Nov 16, 2022

/cc @glefloch, @quarkusio/devtools

@abhishekS14
Copy link

Hi, is anyone investigating this? If not, I'd like to work on it. Thanks!

@gastaldi
Copy link
Contributor Author

@abhishekS14 it's up for grabs, go ahead and submit a PR 😉

@abhishekS14
Copy link

Hi @gastaldi ,
"First-time contributors need a maintainer to approve running workflows" - Can you please approve the PR for the required checks?

@abhishekS14
Copy link

abhishekS14 commented Nov 20, 2022

Hi @gastaldi
Can you please review my new PR? I have squashed the commits in one PR

@gastaldi
Copy link
Contributor Author

@abhishekS14 thanks, good job

@abhijeetgauravm
Copy link

Hey , I want to solve the issue can you please assign to me?

@gastaldi
Copy link
Contributor Author

gastaldi commented Feb 12, 2023

@abhijeetdav24aug Go ahead and provide a PR with a Fixes #29309 in the first comment of your PR

@Gourav2580
Copy link

i want to contribute

@appiepollo14
Copy link
Contributor

PR created

This was referenced Oct 14, 2023
@quarkus-bot quarkus-bot bot added this to the 3.6 - main milestone Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/gradle Gradle good first issue Good for newcomers kind/enhancement New feature or request
Projects
None yet
5 participants