Skip to content

Commit 70fd059

Browse files
committed
[ci] Adjust tagging for javadocs
1 parent 55a1685 commit 70fd059

File tree

2 files changed

+7
-15
lines changed

2 files changed

+7
-15
lines changed

src/main/java/org/mybatis/scripting/freemarker/MyBatisParamDirective.java

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2015-2021 the original author or authors.
2+
* Copyright 2015-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -36,20 +36,18 @@
3636
* Custom FreeMarker directive for generating "#{paramName}" declarations in convenient way. Problem is FreeMarker
3737
* supports this syntax natively and there are no chance to disable this (although it is deprecated). And to get
3838
* "#{paramName}" we should write ${r"#{paramName}"}. With this directive you can write more simple:
39-
*
39+
* <p>
4040
* <blockquote>
4141
*
4242
* <pre>
4343
* &lt;@p name="paramName"/&gt;
4444
* </pre>
4545
*
4646
* </blockquote>
47-
*
4847
* <p>
4948
* Also directive supports `value` attribute. If it is specified, param will take passed value and create the
5049
* corresponding #{}-parameter. This is useful in loops:
5150
* </p>
52-
*
5351
* <blockquote>
5452
*
5553
* <pre>
@@ -60,19 +58,16 @@
6058
* </pre>
6159
*
6260
* </blockquote>
63-
*
6461
* <p>
6562
* will be translated into
6663
* </p>
67-
*
6864
* <blockquote>
6965
*
7066
* <pre>
7167
* #{_p0},#{_p1},#{_p2}
7268
* </pre>
7369
*
7470
* </blockquote>
75-
*
7671
* <p>
7772
* And MyBatis engine will convert it to `?`-params finally.
7873
* </p>

src/main/java/org/mybatis/scripting/freemarker/support/TemplateFilePathProvider.java

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@
2828
import org.mybatis.scripting.freemarker.FreeMarkerLanguageDriverConfig.TemplateFileConfig.PathProviderConfig;
2929

3030
/**
31-
* The SQL provider class that return the SQL template file path. <br>
31+
* The SQL provider class that return the SQL template file path.
32+
* <p>
3233
* <b>IMPORTANT: This class required to use with mybatis 3.5.1+</b> and need to use with SQL provider annotation (such
33-
* as {@link org.apache.ibatis.annotations.SelectProvider} as follow: <br>
34-
* <br>
34+
* as {@link org.apache.ibatis.annotations.SelectProvider} as follow:
35+
* <p>
3536
*
3637
* <pre>
3738
* package com.example.mapper;
@@ -98,11 +99,9 @@ public static void setCustomTemplateFilePathGenerator(PathGenerator pathGenerato
9899
* Set a configuration instance for {@link FreeMarkerLanguageDriver}.
99100
* <p>
100101
* By default, {@link FreeMarkerLanguageDriverConfig#newInstance()} will used.
101-
* </p>
102102
* <p>
103103
* If you applied an user define {@link FreeMarkerLanguageDriverConfig} for {@link FreeMarkerLanguageDriver}, please
104104
* same instance to the this class.
105-
* </p>
106105
*
107106
* @param languageDriverConfig
108107
* A user defined {@link FreeMarkerLanguageDriverConfig}
@@ -114,8 +113,7 @@ public static void setLanguageDriverConfig(FreeMarkerLanguageDriverConfig langua
114113

115114
/**
116115
* Provide an SQL scripting string(template file path).
117-
*
118-
* <br>
116+
* <p>
119117
* By default implementation, a template file path resolve following format and priority order. If does not match all,
120118
* it throw an exception that indicate not found a template file.
121119
* <ul>
@@ -126,7 +124,6 @@ public static void setLanguageDriverConfig(FreeMarkerLanguageDriverConfig langua
126124
* <li>com/example/mapper/BaseMapper/BaseMapper-{methodName}.ftl (fallback using declaring class of method and default
127125
* database)</li>
128126
* </ul>
129-
* <br>
130127
*
131128
* @param context
132129
* a context of SQL provider

0 commit comments

Comments
 (0)