+ Reports comments in the annotater Javadoc editor that are not Markdown documentation comments (///)
+
+ Annotater stores its Javadocs as Markdown, so only Markdown documentation comments can be saved to the annotater checkout.
+ Traditional Javadoc comments (/** */), line comments and block comments are not supported.
+
+/** Returns the maximum stack size. */ // bad
+/// Returns the maximum stack size. // good
+public int getMaxStackSize() {
+
+
+
Index: src/main/resources/inspectionDescriptions/AnnotaterJavadocUnqualifiedReference.html
===================================================================
--- src/main/resources/inspectionDescriptions/AnnotaterJavadocUnqualifiedReference.html (revision 634ba2a6b272ca2ed4475f6cdb19ac28d8a54d3d)
+++ src/main/resources/inspectionDescriptions/AnnotaterJavadocUnqualifiedReference.html (revision 634ba2a6b272ca2ed4475f6cdb19ac28d8a54d3d)
@@ -0,0 +1,38 @@
+
+
+
+
++ Reports classes referenced in annotater Javadocs without their fully qualified name +
+ ++ Annotater Javadocs are applied to Minecraft sources that may have different imports to the file they were written in, so + annotater requires every class referenced from a Javadoc to be written with its fully qualified name. Fully qualified + names can still be shown shortened in the inlay hints, depending on the annotater settings. +
+
+/// Returns the [ItemStack] in the given slot. // bad
+/// Returns the [net.minecraft.world.item.ItemStack] in the given slot. // good
+public ItemStack getItem(int slot) {
+
+
+
Index: src/main/resources/messages/MinecraftDevelopmentBundle.properties
===================================================================
--- src/main/resources/messages/MinecraftDevelopmentBundle.properties (revision 06588b32ecf3aef71d154d97407e0df4021e842b)
+++ src/main/resources/messages/MinecraftDevelopmentBundle.properties (revision 634ba2a6b272ca2ed4475f6cdb19ac28d8a54d3d)
@@ -28,6 +28,8 @@
action.CopyMixinTargetReferenceAction.text=Mixin Target Reference
action.CreateMinecraftClass.description=Create skeleton classes used in Minecraft Mods
action.CreateMinecraftClass.text=Minecraft Class
+action.EditAnnotaterJavadoc.description=Edit the annotater Javadoc of this Minecraft class, field or method
+action.EditAnnotaterJavadoc.text=Edit Annotater Javadoc
action.FindMixinsAction.description=Find classes which mix into this class
action.FindMixinsAction.text=Find Mixins
action.FindSrgMappingAction.description=Find the associated SRG mapping for this element
@@ -227,6 +229,8 @@
inspection.added_enum_constants_name_pattern.name=Name does not match the pattern for added enum constants
inspection.added_mixin_members_name_pattern.name=Name does not match the pattern for added mixin members
inspection.ambiguous_mixin_reference.name=Ambiguous reference
+inspection.annotater_javadoc_comment.name=Unsupported comment in annotater Javadoc
+inspection.annotater_javadoc_unqualified_reference.name=Unqualified class reference in annotater Javadoc
inspection.annotation_outside_of_mixin.name=Mixin annotation outside of @Mixin class
inspection.at_usage.name=Unused access transformer
inspection.bukkit_listener_implemented.name=Bukkit @EventHandler in class not implementing Listener
@@ -396,6 +400,7 @@
nbt.file.save_notify.parse_exception.title=Error saving NBT file
nbt.file.save_notify.parse_exception.content=An unexpected exception happened, {0} could not be saved\: {1}
+notification.group.minecraft_annotater=Minecraft annotater
notification.group.minecraft_development_updates=Minecraft Development updates
notification.group.minecraft_facet=Minecraft facet
notification.group.minecraft_project_creator=Minecraft project creator
@@ -588,11 +593,9 @@
fabric.annotater.javadoc.error.structure_changed=The declarations in the copy of the source file changed. Changes were not saved.
fabric.annotater.javadoc.error.io=Failed to save annotater Javadocs\: {0}
-fabric.annotater.inspection.unqualified.description=Reports classes referenced in annotater Javadocs without their fully qualified name, which annotater requires.
fabric.annotater.inspection.unqualified.problem=Annotater requires fully qualified class names, use ''{0}''
fabric.annotater.inspection.unqualified.fix=Replace with ''{0}''
fabric.annotater.inspection.unqualified.fix.family=Use fully qualified class name
-fabric.annotater.inspection.comment.description=Reports comments in annotater Javadoc editors that are not Markdown Javadoc comments, which annotater does not support.
fabric.annotater.pr.checking=Checking annotater changes
fabric.annotater.pr.nothing=Nothing to submit