From b5680d025d37821c5481d800f3a3cd7033361565 Mon Sep 17 00:00:00 2001 From: Norman Walsh Date: Fri, 20 Sep 2024 08:30:46 +0100 Subject: [PATCH 1/4] More tinkering with the sample for @link testing --- sample/src/main/java/org/example/Locale.java | 5 +++++ sample/src/main/java/org/example/TestClass.java | 4 ++++ .../java/org/example/packagea/ItemProcessor.java | 12 ++++++++++++ sample/src/main/java/org/example/packageb/Item.java | 5 +++++ .../test/java/com/saxonica/xmldoclet/DocletTest.java | 2 ++ 5 files changed, 28 insertions(+) create mode 100644 sample/src/main/java/org/example/Locale.java create mode 100644 sample/src/main/java/org/example/packagea/ItemProcessor.java create mode 100644 sample/src/main/java/org/example/packageb/Item.java diff --git a/sample/src/main/java/org/example/Locale.java b/sample/src/main/java/org/example/Locale.java new file mode 100644 index 0000000..1fa48fc --- /dev/null +++ b/sample/src/main/java/org/example/Locale.java @@ -0,0 +1,5 @@ +package org.example; + +public class Locale { + // Not the java.util.Locale class +} diff --git a/sample/src/main/java/org/example/TestClass.java b/sample/src/main/java/org/example/TestClass.java index 467ad49..2eb290c 100644 --- a/sample/src/main/java/org/example/TestClass.java +++ b/sample/src/main/java/org/example/TestClass.java @@ -4,6 +4,7 @@ import jdk.javadoc.doclet.Reporter; import net.sf.saxon.lib.Feature; import net.sf.saxon.serialize.charcode.CharacterSet; +import java.util.Locale; import java.lang.reflect.Parameter; import java.util.*; @@ -78,6 +79,9 @@ public static int combinePair(char high, char low) { } public void foo(Class spoon) { + } + + public void bar(Locale myLocal) { } diff --git a/sample/src/main/java/org/example/packagea/ItemProcessor.java b/sample/src/main/java/org/example/packagea/ItemProcessor.java new file mode 100644 index 0000000..0a8ecaf --- /dev/null +++ b/sample/src/main/java/org/example/packagea/ItemProcessor.java @@ -0,0 +1,12 @@ +package org.example.packagea; + +import org.example.packageb.Item; + +/** + * This is a link to {@link Item}. + */ +public class ItemProcessor { + public ItemProcessor(Item item) { + + } +} diff --git a/sample/src/main/java/org/example/packageb/Item.java b/sample/src/main/java/org/example/packageb/Item.java new file mode 100644 index 0000000..5ab851e --- /dev/null +++ b/sample/src/main/java/org/example/packageb/Item.java @@ -0,0 +1,5 @@ +package org.example.packageb; + +public class Item { + // an item +} diff --git a/xmldoclet/src/test/java/com/saxonica/xmldoclet/DocletTest.java b/xmldoclet/src/test/java/com/saxonica/xmldoclet/DocletTest.java index b3b8ec9..8547c19 100644 --- a/xmldoclet/src/test/java/com/saxonica/xmldoclet/DocletTest.java +++ b/xmldoclet/src/test/java/com/saxonica/xmldoclet/DocletTest.java @@ -30,6 +30,8 @@ public void sample() { "-docletpath", "build/classes/", "-sourcepath", "../sample/src/main/java", "org.example", + "org.example.packagea", + "org.example.packageb", }; DocumentationTool docTool = ToolProvider.getSystemDocumentationTool(); From 5ea0060134c0ae05ac4eb830d4c88d15de6086ea Mon Sep 17 00:00:00 2001 From: Norman Walsh Date: Fri, 20 Sep 2024 14:51:07 +0100 Subject: [PATCH 2/4] Gradle configuration tweak --- settings.gradle | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/settings.gradle b/settings.gradle index 3b66c65..6728d03 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,2 +1,6 @@ +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version("0.8.0") +} + rootProject.name = 'xmldoclet' include('xmldoclet', 'sample') From 154c6b0e6e285c363294e341cfc0c568219f0f29 Mon Sep 17 00:00:00 2001 From: Norman Walsh Date: Fri, 20 Sep 2024 14:51:20 +0100 Subject: [PATCH 3/4] Use the simple name in method name attributes --- .../com/saxonica/xmldoclet/scanners/XmlExecutableElement.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xmldoclet/src/main/java/com/saxonica/xmldoclet/scanners/XmlExecutableElement.java b/xmldoclet/src/main/java/com/saxonica/xmldoclet/scanners/XmlExecutableElement.java index 9c9ee61..1625a32 100644 --- a/xmldoclet/src/main/java/com/saxonica/xmldoclet/scanners/XmlExecutableElement.java +++ b/xmldoclet/src/main/java/com/saxonica/xmldoclet/scanners/XmlExecutableElement.java @@ -25,7 +25,7 @@ public void scan(DocTree tree) { // Hack if (!"constructor".equals(typeName())) { - attr.put("name", element.toString()); + attr.put("name", element.getSimpleName().toString()); } Map thrownTypes = new HashMap<>(); From 3b5223ca77ceb7004daba4a296369ce65a8b2c7f Mon Sep 17 00:00:00 2001 From: Norman Walsh Date: Fri, 20 Sep 2024 14:52:48 +0100 Subject: [PATCH 4/4] Bump version to 0.8.0 --- README.md | 6 ++++++ gradle.properties | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b67d977..cf18b2d 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,12 @@ incomplete or incorrect, please [open an issue](https://github.com/Saxonica/xmld ## Change log +* **0.8.0** Fixed method names + + Output the “simple” method name in the name attribute on method elements. + The full signature is also provided and the parameters and their types are available + from children. + * **0.7.0** Improved presentation of interfaces Reworked the way interfaces are presented so that the methods inherited diff --git a/gradle.properties b/gradle.properties index a86bd7d..be67956 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,4 +1,4 @@ -docletVersion=0.7.0 -schemaVersion=0.7.0 +docletVersion=0.8.0 +schemaVersion=0.8.0 docletTitle=XmlDoclet docletName=xmldoclet