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

Adding params to constructors without a description causes java11 javadoc warnings #604

Open
loosebazooka opened this issue Jan 15, 2023 · 5 comments
Milestone

Comments

@loosebazooka
Copy link

Started seeing some new javadoc warnings when upgrading from 5.0 -> 6.0

for data like:

...
                "hash": {
                    "description": "Specifies the hash algorithm and value for the content",
                    "type": "object",
                    "properties": {
                        "algorithm": {
                            "description": "The hashing function used to compute the hash value",
                            "type": "string",
                            "enum": [ "sha256" ]
                        },
                        "value": {
                            "description": "The hash value for the content",
                            "type": "string"
                        }
                    },
                    "required": [ "algorithm", "value" ]
                }
...

a constructor is created like:

     /**
      *
      * @param value
      * @param algorithm
      */
     public Hash(Hash.Algorithm algorithm, String value) {
         super();
         this.algorithm = algorithm;
         this.value = value;
     }

Would it make sense to inject the description into the generated javadoc here so we don't get javadoc generation warnings (happens with Temurin Java11) like:

/home/.../Hash.java:44: warning: no description for @param
     * @param value
       ^
@loosebazooka
Copy link
Author

Hrmm, maybe think this is actually an issue on the core library.

@eirnym
Copy link
Collaborator

eirnym commented Jan 15, 2023

Yes, it's surely an issue of the processor library.

@loosebazooka
Copy link
Author

@eirnym jsonscheme2pojo has released 1.2.x with this update. I don't see a way to update my reference to it in the plugin. Do this project need to push an update?

@eirnym
Copy link
Collaborator

eirnym commented Feb 22, 2023

@loosebazooka thank you for a heads up.

While I'm working on a new version, you can use a trick to define dependency explicitly as shown in a classpath demo projects. I hope new version will be released soon

@loosebazooka
Copy link
Author

np, I can wait.

@eirnym eirnym added this to the 7.0.0 milestone Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants