Skip to content

Commit d90f85f

Browse files
committed
Update reference doc and javadoc for gh-842
1 parent a8a8f1f commit d90f85f

File tree

6 files changed

+30
-10
lines changed

6 files changed

+30
-10
lines changed

src/main/java/org/apache/ibatis/annotations/CacheNamespaceRef.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/**
2525
* The annotation that reference a cache.
2626
* <p>
27-
* If you use this annotation, should be specified either {@link #value()} and {@link #name()} attribute.
27+
* If you use this annotation, should be specified either {@link #value()} or {@link #name()} attribute.
2828
* </p>
2929
* @author Clinton Begin
3030
* @author Kazuki Shimizu

src/site/es/xdoc/java-api.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,12 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
325325
<td><code>@CacheNamespaceRef</code></td>
326326
<td><code>Class</code></td>
327327
<td><code>&lt;cacheRef&gt;</code></td>
328-
<td>Referencia una cache de otro namespace. Atributos: value, que debe ser el nombre del namespace (ej. un nombre de clase completamente cualificado).</td>
328+
<td>
329+
Referencia una cache de otro namespace. Atributos: <code>value</code> and <code>name</code>.
330+
If you use this annotation, you should be specified either <code>value</code> or <code>name</code> attribute.
331+
For the <code>value</code> attribute specify a java type indicating the namespace(the namespace name become a FQCN of specified java type),
332+
and for the <code>name</code> attribute(this attribute is available since 3.4.2) specify a name indicating the namespace.
333+
</td>
329334
</tr>
330335
<tr>
331336
<td><code>@ConstructorArgs</code></td>

src/site/ja/xdoc/java-api.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,12 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
333333
<td><code>@CacheNamespaceRef</code></td>
334334
<td><code>Class</code></td>
335335
<td><code>&lt;cacheRef&gt;</code></td>
336-
<td>別のネームスペースに対して定義されているキャッシュの設定を参照します。 単一値 <code>value</code> として参照先のキャッシュが定義されているネームスペース(完全修飾クラス名)を指定します。</td>
336+
<td>
337+
別のネームスペースに対して定義されているキャッシュの設定を参照します。 属性: <code>value</code>, <code>name</code>
338+
このアノテーションを使用する場合は、<code>value</code>または<code>name</code>属性のどちらかを指定する必要があります。
339+
<code>value</code>属性にはネームスペースを示すJava型(ネームスペース名は指定したJava型のFQCNになる)を、
340+
<code>name</code>属性(この属性は3.4.2以降で利用可能)にはネームスペースを示す名前を指定します。
341+
</td>
337342
</tr>
338343
<tr>
339344
<td><code>@ConstructorArgs</code></td>

src/site/ko/xdoc/java-api.xml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -422,8 +422,12 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
422422
<td><code>@CacheNamespaceRef</code></td>
423423
<td><code>Class</code></td>
424424
<td><code>&lt;cacheRef&gt;</code></td>
425-
<td>다른 명명공간의 캐시에 대한 참조
426-
사용가능한 속성들 : value(명명공간의 이름).</td>
425+
<td>
426+
다른 명명공간의 캐시에 대한 참조 사용가능한 속성들 : <code>value</code>, <code>name</code>.
427+
If you use this annotation, you should be specified either <code>value</code> or <code>name</code> attribute.
428+
For the <code>value</code> attribute specify a java type indicating the namespace(the namespace name become a FQCN of specified java type),
429+
and for the <code>name</code> attribute(this attribute is available since 3.4.2) specify a name indicating the namespace.
430+
</td>
427431
</tr>
428432
<tr>
429433
<td><code>@ConstructorArgs</code></td>

src/site/xdoc/java-api.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,12 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
342342
<td><code>@CacheNamespaceRef</code></td>
343343
<td><code>Class</code></td>
344344
<td><code>&lt;cacheRef&gt;</code></td>
345-
<td>References the cache of another namespace to use. Attributes: <code>value</code>, which should be the string value of a namespace (i.e. a fully qualified class name).</td>
345+
<td>
346+
References the cache of another namespace to use. Attributes: <code>value</code> and <code>name</code>.
347+
If you use this annotation, you should be specified either <code>value</code> or <code>name</code> attribute.
348+
For the <code>value</code> attribute specify a java type indicating the namespace(the namespace name become a FQCN of specified java type),
349+
and for the <code>name</code> attribute(this attribute is available since 3.4.2) specify a name indicating the namespace.
350+
</td>
346351
</tr>
347352
<tr>
348353
<td><code>@ConstructorArgs</code></td>

src/site/zh/xdoc/java-api.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -538,10 +538,11 @@ flushInterval,size,readWrite,blocking 和 properties。
538538
<td><code>@CacheNamespaceRef</code></td>
539539
<td><code>类</code></td>
540540
<td><code>&lt;cacheRef&gt;</code></td>
541-
<td>参照另外一个命名空间的缓存来使用。
542-
属性:value,应该是一个名空间的字
543-
符串值(也就是类的完全限定名)
544-
541+
<td>
542+
参照另外一个命名空间的缓存来使用。属性:value, name。
543+
If you use this annotation, you should be specified either <code>value</code> or <code>name</code> attribute.
544+
For the <code>value</code> attribute specify a java type indicating the namespace(the namespace name become a FQCN of specified java type),
545+
and for the <code>name</code> attribute(this attribute is available since 3.4.2) specify a name indicating the namespace.
545546
</td>
546547
</tr>
547548
<tr>

0 commit comments

Comments
 (0)