search

stleary / JSON-java

A reference implementation of a JSON package in Java.
http://stleary.github.io/JSON-java/index.html
Other
4.54k stars 2.56k forks source link

JavaDoc warnings are present #853

Closed javadev closed 9 months ago

javadev commented 9 months ago 
[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 commented 9 months ago

I have prepared a fix https://github.com/stleary/JSON-java/pull/854

stleary commented 9 months ago

@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 commented 9 months ago

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

stleary commented 9 months ago

Closing due to PR approved