Skip to content
This repository was archived by the owner on Dec 4, 2025. It is now read-only.

Commit 02ab03c

Browse files
authored
Merge pull request #767 from shalousun/master
optimised: Optimise the error prompt for incorrect Javadoc tag usage.
2 parents 1da77ed + 00ee498 commit 02ab03c

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
<dependency>
4747
<groupId>com.ibeetl</groupId>
4848
<artifactId>beetl</artifactId>
49-
<version>3.15.13.RELEASE</version>
49+
<version>3.16.0.RELEASE</version>
5050
</dependency>
5151
<dependency>
5252
<groupId>com.ly.smart-doc</groupId>

src/main/java/com/ly/doc/utils/DocUtil.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ public static List<String> split(String url) {
552552
public static Map<String, String> getCommentsByTag(final JavaMethod javaMethod, final String tagName, final String className) {
553553
List<DocletTag> paramTags = javaMethod.getTagsByName(tagName);
554554
String tagValNullMsg = "ERROR: #" + javaMethod.getName()
555-
+ "() - bad @" + tagName + " javadoc from " + javaMethod.getDeclaringClass()
555+
+ "() - bad @" + tagName + " Javadoc tag usage from " + javaMethod.getDeclaringClass()
556556
.getCanonicalName() + ", This is an invalid comment.";
557557
String tagValErrorMsg = "ERROR: An invalid comment was written [@" + tagName + " |]," +
558558
"Please @see " + javaMethod.getDeclaringClass().getCanonicalName() + "." + javaMethod.getName() + "()";
@@ -563,7 +563,7 @@ public static Map<String, String> getRecordCommentsByTag(JavaClass javaClass, fi
563563
List<DocletTag> paramTags = javaClass.getTagsByName(tagName);
564564
String className = javaClass.getCanonicalName();
565565
String tagValNullMsg = "ERROR: "
566-
+ "Bad @" + tagName + " javadoc from " + className
566+
+ "Bad @" + tagName + " Javadoc tag usage from " + className
567567
+ ", This is an invalid comment.";
568568
String tagValErrorMsg = "ERROR: An invalid comment was written [@" + tagName + " |]," +
569569
"Please @see " + className;

src/main/java/com/ly/doc/utils/JavaClassUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@ public static String getClassTagsValue(final JavaClass cls, final String tagName
609609
String value = tag.getValue();
610610
if (StringUtil.isEmpty(value) && checkComments) {
611611
throw new RuntimeException("ERROR: #" + cls.getName()
612-
+ "() - bad @" + tagName + " javadoc from " + cls.getName() + ", must be add comment if you use it.");
612+
+ "() - bad @" + tagName + " Javadoc tag usage from " + cls.getName() + ", must be add comment if you use it.");
613613
}
614614
if (tagName.equals(tag.getName())) {
615615
if (result.length() > 0) {

0 commit comments

Comments
 (0)