Merge pull request #850 from kazuki43zoo/update-doc-for-gh-842

Update reference doc and javadoc for gh-842

Author: kazuki43zoo

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

@@ -24,7 +24,7 @@
 /**
  * The annotation that reference a cache.
  * <p>
- * If you use this annotation, should be specified either {@link #value()} and {@link #name()} attribute.
+ * If you use this annotation, should be specified either {@link #value()} or {@link #name()} attribute.
  * </p>
  * @author Clinton Begin
  * @author Kazuki Shimizu

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

@@ -325,7 +325,12 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
         <td><code>@CacheNamespaceRef</code></td>
         <td><code>Class</code></td>
         <td><code>&lt;cacheRef&gt;</code></td>
-        <td>Referencia una cache de otro namespace. Atributos: value, que debe ser el nombre del namespace (ej. un nombre de clase completamente cualificado).</td>
+        <td>
+          Referencia una cache de otro namespace. Atributos: <code>value</code> and <code>name</code>.
+          If you use this annotation, you should be specified either <code>value</code> or <code>name</code> attribute.
+          For the <code>value</code> attribute specify a java type indicating the namespace(the namespace name become a FQCN of specified java type),
+          and for the <code>name</code> attribute(this attribute is available since 3.4.2) specify a name indicating the namespace.
+        </td>
       </tr>
       <tr>
         <td><code>@ConstructorArgs</code></td>

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

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

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

@@ -422,8 +422,12 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
         <td><code>@CacheNamespaceRef</code></td>
         <td><code>Class</code></td>
         <td><code>&lt;cacheRef&gt;</code></td>
-        <td>다른 명명공간의 캐시에 대한 참조
-		사용가능한 속성들 : value(명명공간의 이름).</td>
+        <td>
+          다른 명명공간의 캐시에 대한 참조 사용가능한 속성들 : <code>value</code>, <code>name</code>.
+          If you use this annotation, you should be specified either <code>value</code> or <code>name</code> attribute.
+          For the <code>value</code> attribute specify a java type indicating the namespace(the namespace name become a FQCN of specified java type),
+          and for the <code>name</code> attribute(this attribute is available since 3.4.2) specify a name indicating the namespace.
+        </td>
       </tr>
       <tr>
         <td><code>@ConstructorArgs</code></td>

src/site/xdoc/java-api.xml

@@ -342,7 +342,12 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
         <td><code>@CacheNamespaceRef</code></td>
         <td><code>Class</code></td>
         <td><code>&lt;cacheRef&gt;</code></td>
-        <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>
+        <td>
+          References the cache of another namespace to use. Attributes: <code>value</code> and <code>name</code>.
+          If you use this annotation, you should be specified either <code>value</code> or <code>name</code> attribute.
+          For the <code>value</code> attribute specify a java type indicating the namespace(the namespace name become a FQCN of specified java type),
+          and for the <code>name</code> attribute(this attribute is available since 3.4.2) specify a name indicating the namespace.
+        </td>
       </tr>
       <tr>
         <td><code>@ConstructorArgs</code></td>

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

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