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 are present #853

Closed
javadev opened this issue Feb 1, 2024 · 4 comments
Closed

JavaDoc warnings are present #853

javadev opened this issue Feb 1, 2024 · 4 comments

Comments

@javadev
Copy link
Contributor

javadev commented Feb 1, 2024

[INFO] --- maven-javadoc-plugin:3.5.0:jar (attach-javadocs) @ json ---
[INFO] No previous run data found, generating javadoc.
Warning:  Javadoc Warnings
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/JSONObject.java:372: warning: empty <p> tag
Warning:  * <p>
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/JSONObject.java:151: warning: no comment
Warning:  public Class<? extends Map> getMapType() {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/JSONObject.java:2235: warning: no comment
Warning:  public static Writer quote(String string, Writer w) throws IOException {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/JSONPointer.java:166: warning: no comment
Warning:  public JSONPointer(List<String> refTokens) {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/JSONPointerException.java:17: warning: no comment
Warning:  public JSONPointerException(String message) {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/JSONPointerException.java:21: warning: no comment
Warning:  public JSONPointerException(String message, Throwable cause) {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/JSONTokener.java:528: warning: no comment
Warning:  public void close() throws IOException {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/ParserConfiguration.java:32: warning: no comment
Warning:  public ParserConfiguration() {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/ParserConfiguration.java:37: warning: no comment
Warning:  protected ParserConfiguration(final boolean keepStrings, final int maxNestingDepth) {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/XML.java:59: warning: no comment
Warning:  public static final String TYPE_ATTR = "xsi:type";
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/XMLParserConfiguration.java:355: warning: no comment
Warning:  public boolean isCloseEmptyTag() {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/XMLParserConfiguration.java:358: warning: no comment
Warning:  public boolean shouldTrimWhiteSpace() {
Warning:  ^
Warning:  /home/runner/work/JSON-java/JSON-java/src/main/java/org/json/XMLXsiTypeConverter.java:[45](https://github.com/stleary/JSON-java/actions/runs/7675474249/job/20921750350#step:9:46): warning: no comment
Warning:  T convert(String value);
Warning:  ^
Warning: [WARNING] 13 warnings
@javadev
Copy link
Contributor Author

javadev commented Feb 2, 2024

I have prepared a fix #854

@stleary
Copy link
Owner

stleary commented Feb 2, 2024

@javadev Thanks for raising this issue. I am unable to recreate this output locally. How did you execute the build? I.E. what command line parameters and what Java version did you build with?

@javadev
Copy link
Contributor Author

javadev commented Feb 2, 2024

I tested it with java 17, mvn javadoc:javadoc command

@stleary
Copy link
Owner

stleary commented Feb 10, 2024

Closing due to PR approved

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