Skip to content

Commit 55a1685

Browse files
committed
[ci] Javadoc formatting
1 parent 1cb65b8 commit 55a1685

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

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

Lines changed: 3 additions & 1 deletion
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.
@@ -60,6 +60,7 @@ public FreeMarkerLanguageDriver() {
6060
*
6161
* @param driverConfig
6262
* a language driver configuration
63+
*
6364
* @since 1.2.0
6465
*/
6566
public FreeMarkerLanguageDriver(FreeMarkerLanguageDriverConfig driverConfig) {
@@ -102,6 +103,7 @@ protected freemarker.template.Configuration createFreeMarkerConfiguration() {
102103
* Creates a {@link ParameterHandler} that passes the actual parameters to the the JDBC statement.
103104
*
104105
* @see DefaultParameterHandler
106+
*
105107
* @param mappedStatement
106108
* The mapped statement that is being executed
107109
* @param parameterObject

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

Lines changed: 8 additions & 1 deletion
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.
@@ -45,6 +45,7 @@
4545
* Configuration class for {@link FreeMarkerLanguageDriver}.
4646
*
4747
* @author Kazuki Shimizu
48+
*
4849
* @since 1.2.0
4950
*/
5051
public class FreeMarkerLanguageDriverConfig {
@@ -89,6 +90,7 @@ public Map<String, String> getFreemarkerSettings() {
8990
* </p>
9091
*
9192
* @return a base directory for reading template resources
93+
*
9294
* @deprecated Recommend to use the {@link TemplateFileConfig#getBaseDir()}} because this method defined for keeping
9395
* backward compatibility (There is possibility that this method removed at a future version)
9496
*/
@@ -102,6 +104,7 @@ public String getBasePackage() {
102104
*
103105
* @param basePackage
104106
* a base directory for reading template resources
107+
*
105108
* @deprecated Recommend to use the {@link TemplateFileConfig#setBaseDir(String)} because this method defined for
106109
* keeping backward compatibility (There is possibility that this method removed at a future version)
107110
*/
@@ -352,7 +355,9 @@ public static FreeMarkerLanguageDriverConfig newInstance() {
352355
*
353356
* @param customProperties
354357
* custom configuration properties
358+
*
355359
* @return a configuration instance
360+
*
356361
* @see #newInstance()
357362
*/
358363
public static FreeMarkerLanguageDriverConfig newInstance(Properties customProperties) {
@@ -368,7 +373,9 @@ public static FreeMarkerLanguageDriverConfig newInstance(Properties customProper
368373
*
369374
* @param customizer
370375
* baseline customizer
376+
*
371377
* @return a configuration instance
378+
*
372379
* @see #newInstance()
373380
*/
374381
public static FreeMarkerLanguageDriverConfig newInstance(Consumer<FreeMarkerLanguageDriverConfig> customizer) {

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

Lines changed: 4 additions & 1 deletion
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.
@@ -66,6 +66,7 @@
6666
* </pre>
6767
*
6868
* @author Kazuki Shimizu
69+
*
6970
* @version 1.2.0
7071
*/
7172
public class TemplateFilePathProvider {
@@ -129,6 +130,7 @@ public static void setLanguageDriverConfig(FreeMarkerLanguageDriverConfig langua
129130
*
130131
* @param context
131132
* a context of SQL provider
133+
*
132134
* @return an SQL scripting string(template file path)
133135
*/
134136
@SuppressWarnings("unused")
@@ -230,6 +232,7 @@ public interface PathGenerator {
230232
* a mapper method that specified provider
231233
* @param databaseId
232234
* a database id that provided from {@link org.apache.ibatis.mapping.DatabaseIdProvider}
235+
*
233236
* @return a template file path
234237
*/
235238
String generatePath(Class<?> type, Method method, String databaseId);

0 commit comments

Comments
 (0)