From 04184272c357fa63e63df8f93f52713e63079e15 Mon Sep 17 00:00:00 2001 From: Pascal Essiembre Date: Sun, 15 Sep 2024 01:24:35 -0400 Subject: [PATCH] Resolved javadoc generation issues + deprecated custom taglets. --- pom.xml | 207 ++++-------------- src/main/assembly/README.txt | 8 +- src/main/assembly/dist.xml | 7 +- src/main/assembly/install.bat | 14 +- src/main/assembly/install.sh | 14 +- .../com/norconex/commons/lang/Operator.java | 5 +- .../com/norconex/commons/lang/SystemUtil.java | 4 +- .../commons/lang/TimeIdGenerator.java | 4 +- .../commons/lang/bean/BeanMapper.java | 10 +- .../norconex/commons/lang/bean/BeanUtil.java | 55 ++--- .../lang/bean/FluentPropertyDescriptor.java | 8 +- .../lang/config/ConfigurationLoader.java | 12 +- .../commons/lang/encrypt/EncryptionKey.java | 31 +-- .../lang/javadoc/AbstractInlineTaglet.java | 2 + .../commons/lang/javadoc/BlockTaglet.java | 2 + .../commons/lang/javadoc/HtmlTaglet.java | 2 + .../lang/javadoc/IncludeDirective.java | 1 + .../commons/lang/javadoc/IncludeTaglet.java | 6 +- .../commons/lang/javadoc/JsonTaglet.java | 2 + .../commons/lang/javadoc/TagContent.java | 1 + .../commons/lang/javadoc/TagletUtil.java | 14 +- .../lang/javadoc/XmlExampleTaglet.java | 8 +- .../commons/lang/javadoc/XmlTaglet.java | 14 +- .../commons/lang/javadoc/XmlUsageTaglet.java | 12 +- .../commons/lang/javadoc/package-info.java | 2 + .../commons/lang/map/PropertySetter.java | 4 - .../commons/lang/security/Credentials.java | 9 +- .../com/norconex/commons/lang/text/Regex.java | 2 +- .../commons/lang/text/TextMatcher.java | 4 +- .../norconex/commons/lang/time/DateModel.java | 2 +- .../commons/lang/time/DurationParser.java | 6 +- .../lang/time/ZonedDateTimeParser.java | 6 +- .../norconex/commons/lang/unit/DataUnit.java | 6 +- .../commons/lang/unit/DataUnitParser.java | 8 +- .../commons/lang/url/UrlNormalizer.java | 6 +- .../lang/version/SemanticVersionParser.java | 2 +- .../com/norconex/commons/lang/xml/Xml.java | 8 +- .../commons/lang/xml/flow/XmlFlow.java | 52 ++--- .../norconex/commons/lang/xml/flow/XmlIf.java | 44 ++-- .../commons/lang/javadoc/TagletTest.java | 8 +- 40 files changed, 214 insertions(+), 398 deletions(-) diff --git a/pom.xml b/pom.xml index 526dbd45..fd78b7b1 100644 --- a/pom.xml +++ b/pom.xml @@ -29,6 +29,8 @@ 17 ${java.version} ${java.version} + ${java.version} + UTF-8 UTF-8 norconex @@ -67,7 +69,7 @@ 1.16.0 - 1.18.32 + 1.18.34 @@ -398,39 +400,6 @@ - - - org.jacoco jacoco-maven-plugin @@ -466,6 +435,20 @@ lombok ${lombok.version} + + + + org.apache.commons + commons-lang3 + ${commons-lang3.version} + + + com.fasterxml.jackson.core + jackson-annotations + ${jackson.version} + + + @@ -506,15 +489,6 @@ generate-resources - @@ -555,11 +529,18 @@ org.apache.maven.plugins maven-compiler-plugin - 3.11.0 + 3.13.0 ${maven.compiler.source} ${maven.compiler.target} UTF-8 + + + org.projectlombok + lombok + ${lombok.version} + + @@ -572,100 +553,30 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.4.1 + 3.10.0 - ${project.build.directory}/site - ${project.build.directory}/site/apidocs - ${project.build.directory}/site/apidocs/norconex-javadoc.css - - - false - - - - - - - + ${project.build.directory}/site + ${project.build.directory}/generated-sources/delombok + + com/norconex/**/*.java + + + com/fasterxml/**/*.java + com/norconex/commons/lang/javadoc/**/*.java + - --allow-script-in-comments - -J-Dbasedir=${basedir} + -Xdoclint:all + -Xdoclint:-missing - src/main/javadoc/overview.html - ${project.name} API - - - - - - - ]]> - -
- ]]> -
- protected false - - ${project.build.directory}/generated-sources/delombok false - - - - - https://commons.apache.org/proper/commons-lang/javadocs/api-release https://commons.apache.org/proper/commons-collections/javadocs/api-${commons-collections4.version} @@ -675,36 +586,8 @@ https://commons.apache.org/proper/commons-logging/javadocs/api-release https://velocity.apache.org/engine/${velocity-engine.version}/apidocs https://www.slf4j.org/apidocs - https://javadoc.io/doc/com.tdunning/json/latest - - - https://junit.org/junit5/docs/${junit-jupiter.version}/api - https://logging.apache.org/log4j/2.x/log4j-api/apidocs - https://ant.apache.org/manual/api - - - - com.norconex.commons.lang.javadoc.IncludeTaglet - com.norconex.commons.lang.javadoc.XMLTaglet - com.norconex.commons.lang.javadoc.XMLUsageTaglet - com.norconex.commons.lang.javadoc.XMLExampleTaglet - com.norconex.commons.lang.javadoc.BlockTaglet - com.norconex.commons.lang.javadoc.HTMLTaglet - com.norconex.commons.lang.javadoc.JSONTaglet - - - - com.norconex.commons - norconex-commons-lang - ${project.version} - - @@ -720,7 +603,7 @@ org.apache.maven.plugins maven-source-plugin - 3.2.1 + 3.3.1 attach-sources @@ -796,16 +679,10 @@ - - org.apache.maven.plugins - maven-dependency-plugin - 3.5.1 - - org.apache.maven.plugins maven-site-plugin - 4.0.0-M7 + 4.0.0-M16 org.apache.maven.wagon @@ -840,7 +717,7 @@ org.apache.maven.plugins maven-enforcer-plugin - 3.3.0 + 3.5.0 enforce-versions diff --git a/src/main/assembly/README.txt b/src/main/assembly/README.txt index e7426723..74b8d21e 100644 --- a/src/main/assembly/README.txt +++ b/src/main/assembly/README.txt @@ -1,5 +1,5 @@ Norconex Commons Lang -Copyright 2008 Norconex Inc. +Copyright 2008-2024 Norconex Inc. General Information: ==================== @@ -20,6 +20,6 @@ See LICENSE.txt for a copy of that license. Third-party licenses: ===================== -For third-party licenses, read the third-party/THIRD-PARTY.txt file. -A copy of third-party license files can be found under the "third-party" -directory. +Refer to "third-party/licenses.xml" for a listing of third party licenses. +A copy of third-party license files can also be found under the +"third-party/licenses" directory. diff --git a/src/main/assembly/dist.xml b/src/main/assembly/dist.xml index 813f946e..1d1c094c 100644 --- a/src/main/assembly/dist.xml +++ b/src/main/assembly/dist.xml @@ -1,5 +1,5 @@ - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * --> + * </else> + * </if> * - * - * - * - * - * } + * <!-- Proceed if condition is false. --> + * <ifNot> + * <!-- Same as "if" tag --> + * </ifNot> + * * @param type of the object to be submitted to the flow. * @since 2.0.0 */ diff --git a/src/main/java/com/norconex/commons/lang/xml/flow/XmlIf.java b/src/main/java/com/norconex/commons/lang/xml/flow/XmlIf.java index 757c1df2..5dcc8250 100644 --- a/src/main/java/com/norconex/commons/lang/xml/flow/XmlIf.java +++ b/src/main/java/com/norconex/commons/lang/xml/flow/XmlIf.java @@ -49,37 +49,37 @@ * {@link Predicate} which trigger {@link Consumer} objects if evaluating * to true. *

- *

XML Syntax

- * {@nx.xml - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * } + * --> + * </else> + * </if> + * * @since 2.0.0 */ @ToString @@ -138,7 +138,7 @@ public void loadFromXML(Xml xml) { .replaceAll("[\n\r]", ""), 40) + "\""); } - var cond = new XmlCondition(flow); + var cond = new XmlCondition<>(flow); cond.loadFromXML(bag.get(0)); condition = cond; diff --git a/src/test/java/com/norconex/commons/lang/javadoc/TagletTest.java b/src/test/java/com/norconex/commons/lang/javadoc/TagletTest.java index e75b0e21..fd4ec96f 100644 --- a/src/test/java/com/norconex/commons/lang/javadoc/TagletTest.java +++ b/src/test/java/com/norconex/commons/lang/javadoc/TagletTest.java @@ -35,6 +35,7 @@ import org.apache.commons.lang3.StringUtils; import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; @@ -45,6 +46,7 @@ import jdk.javadoc.doclet.Taglet.Location; +@Disabled class TagletTest { private static String TEST_XML = escapeHtml4(""" @@ -93,7 +95,7 @@ static void beforeAll() throws IOException { Path.of(javadocDir + "/" + classAsPath + ".html")); html = StringUtils.substringAfterLast(html, "=== METHOD DETAIL ==="); var m = Pattern.compile( - "

(.*?)

.*?
(.*?)
", + "

(.*?)

.*?
(.*?)
", Pattern.DOTALL).matcher(html); while (m.find()) { methodJavadocs.put(m.group(1), m.group(2).replaceAll("\r", "")); @@ -124,9 +126,9 @@ void testXMLNoParent() { @Test void testXMLUsage() { var expected = - "

" + "

" + "XML configuration usage:" - + "

\n\n" + + "\n\n" + "
\n"
                         + TEST_XML
                         + "
";