Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Modified Javadoc for ver 0.4.0 (#206).

  • Loading branch information...
commit 955135ce3faa815102e2d18578072755d58d5a25 1 parent ed098e1
@akirakw akirakw authored
Showing with 29 additions and 22 deletions.
  1. +2 −2 src/main/javadoc/overview.html → asakusa-parent/src/main/javadoc/overview-summary.html
  2. +1 −1  core-project/asakusa-runtime/src/main/java/com/asakusafw/runtime/io/util/WritableRawComparable.java
  3. +1 −1  directio-project/asakusa-directio-plugin/src/main/java/com/asakusafw/compiler/directio/OutputPattern.java
  4. +2 −5 ...rarr; directio-project/asakusa-directio-tools/src/main/java/com/asakusafw/directio/tools}/package-info.java
  5. +1 −1  ...ion-project/asakusa-operation-tools/src/main/java/com/asakusafw/operation/tools/hadoop/fs/package-info.java
  6. +1 −0  pom.xml
  7. +1 −1  testing-project/asakusa-test-moderator/src/main/java/com/asakusafw/testdriver/core/ModelVerifier.java
  8. +1 −1  testing-project/asakusa-test-moderator/src/main/java/com/asakusafw/testdriver/core/VerifyRule.java
  9. +7 −3 ...gate-project/asakusa-thundergate/src/main/java/com/asakusafw/bulkloader/cache/DeleteCacheStorageRemote.java
  10. +7 −3 thundergate-project/asakusa-thundergate/src/main/java/com/asakusafw/bulkloader/cache/GetCacheInfoRemote.java
  11. +2 −1  thundergate-project/asakusa-thundergate/src/main/java/com/asakusafw/bulkloader/collector/ExportFileSend.java
  12. +3 −3 thundergate-project/asakusa-thundergate/src/main/java/com/asakusafw/bulkloader/extractor/DfsFileImport.java
View
4 src/main/javadoc/overview.html → ...usa-parent/src/main/javadoc/overview-summary.html
@@ -1,5 +1,5 @@
<body>
-This document is the API specification for Asakusa Framework version {@code 0.2}.
+This document is the API specification for Asakusa Framework.
<h2>Overview</h2>
<p>
@@ -8,5 +8,5 @@
<p>
Asakusa consists of the following components: (1) MapReduce DSL compiler (Ashigel Compiler), (2) a data model generator for Hadoop data format, and (3) integrated test suites tools. Ashigel compiler compiles the DSLs (multi-layered DSLs, business workflow DSL, logic flow DSL, and data operator DSL) into MapReduce programs. The model generator takes RDBMS schema as an input, and generates the Hadoop I/O classes and the corresponding test codes. For the ease of the development, the test suite tools integrate the Ashigel compiler and the model generator.
</p>
-@see <a href="http://asakusafw.s3.amazonaws.com/documents/0.2/release/ja/html/index.html">Asakusa Framework 0.2 Documentaion (Ja)</a>
+@see <a href="http://github.com/asakusafw/asakusafw/wiki">Asakusa Framework Wiki</a>
</body>
View
2  core-project/asakusa-runtime/src/main/java/com/asakusafw/runtime/io/util/WritableRawComparable.java
@@ -21,7 +21,7 @@
/**
* {@link WritableComparable} which is comparable in is bytes.
- * Clients must override {@link #hashCode()} and {@link #equals(Object)}.
+ * Clients must override {@link Object#hashCode()} and {@link Object#equals(Object)}.
* @since 0.2.5
*/
public interface WritableRawComparable extends WritableComparable<WritableRawComparable> {
View
2  directio-project/asakusa-directio-plugin/src/main/java/com/asakusafw/compiler/directio/OutputPattern.java
@@ -650,7 +650,7 @@ public boolean isAscend() {
/**
* Source is a property.
- * @see DataClass.Property
+ * @see com.asakusafw.compiler.flow.DataClass.Property
*/
PROPERTY,
View
7 ...n/java/com/asakusafw/testdriver/package-info.java → ...va/com/asakusafw/directio/tools/package-info.java
@@ -14,9 +14,6 @@
* limitations under the License.
*/
/**
- * テストドライバ用のクラス群。
- * <p>
- * アプリケーションテスト開発者は本パッケージで提供するクラス郡を使用してテストメソッドを記述する。
- * </p>
+ * Command Line Tools for Direct I/O.
*/
-package com.asakusafw.testdriver;
+package com.asakusafw.directio.tools;
View
2  ...-project/asakusa-operation-tools/src/main/java/com/asakusafw/operation/tools/hadoop/fs/package-info.java
@@ -14,6 +14,6 @@
* limitations under the License.
*/
/**
- * Command Line Tools for Hadoop FileSystm.
+ * Command Line Tools for Hadoop FileSystem.
*/
package com.asakusafw.operation.tools.hadoop.fs;
View
1  pom.xml
@@ -70,6 +70,7 @@
<doctitle>Asakusa Framework API References (Version ${project.version})</doctitle>
<windowtitle>Asakusa Framework API References (Version ${project.version})</windowtitle>
<excludePackageNames>com.asakusafw.modelgen:com.asakusafw.testtools</excludePackageNames>
+ <overview>asakusa-parent/src/main/javadoc/overview-summary.html</overview>
</configuration>
<executions>
<execution>
View
2  testing-project/asakusa-test-moderator/src/main/java/com/asakusafw/testdriver/core/ModelVerifier.java
@@ -26,7 +26,7 @@
* Returns the key of the target data model.
* <p>
* This method must return objects which have
- * both {@link #equals(Object)} and {@link #hashCode()}.
+ * both {@link Object#equals(Object)} and {@link Object#hashCode()}.
* </p>
* <p>
* example:
View
2  testing-project/asakusa-test-moderator/src/main/java/com/asakusafw/testdriver/core/VerifyRule.java
@@ -25,7 +25,7 @@
* Returns the key of the target data model.
* <p>
* This method must return objects which have
- * both {@link #equals(Object)} and {@link #hashCode()}.
+ * both {@link Object#equals(Object)} and {@link Object#hashCode()}.
* </p>
* @param target the target
* @return the key
View
10 ...e-project/asakusa-thundergate/src/main/java/com/asakusafw/bulkloader/cache/DeleteCacheStorageRemote.java
@@ -38,9 +38,13 @@
/**
* Program entry for deleting cache storage.
- * This requires {@link FileList} with {@link FileProtocol.Kind#DELETE_CACHE} on standard input.
- * And then this returns {@link FileList} with {@link FileProtocol.Kind#RESPONSE_DELETED} and/or
- * {@link FileProtocol.Kind#RESPONSE_NOT_FOUND} on standard output.
+ * This requires {@link FileList} with
+ * {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#DELETE_CACHE}
+ * on standard input.
+ * And then this returns {@link FileList} with
+ * {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#RESPONSE_DELETED} and/or
+ * {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#RESPONSE_NOT_FOUND}
+ * on standard output.
* This program requires following arguments:
* <ol>
* <li> target name </li>
View
10 ...dergate-project/asakusa-thundergate/src/main/java/com/asakusafw/bulkloader/cache/GetCacheInfoRemote.java
@@ -39,9 +39,13 @@
/**
* Program entry for fetching {@link CacheInfo}.
- * This requires {@link FileList} with {@link FileProtocol.Kind#GET_CACHE_INFO} on standard input.
- * And then this returns {@link FileList} with {@link FileProtocol.Kind#RESPONSE_CACHE_INFO} and/or
- * {@link FileProtocol.Kind#RESPONSE_NOT_FOUND} on standard output.
+ * This requires {@link FileList} with
+ * {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#GET_CACHE_INFO}
+ * on standard input.
+ * And then this returns {@link FileList} with
+ * {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#RESPONSE_CACHE_INFO} and/or
+ * {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#RESPONSE_NOT_FOUND}
+ * on standard output.
* This program requires following arguments:
* <ol>
* <li> target name </li>
View
3  ...dergate-project/asakusa-thundergate/src/main/java/com/asakusafw/bulkloader/collector/ExportFileSend.java
@@ -150,7 +150,8 @@ public boolean sendExportFile(ExporterBean bean, String user) {
}
}
/**
- * 指定された一時ファイルを読み込んでTSV形式で{@link FileList.Writer}に書き出す。
+ * 指定された一時ファイルを読み込んでTSV形式で
+ * {@link com.asakusafw.bulkloader.transfer.FileList.Writer}に書き出す。
* @param <T> データモデルの型
* @param targetTableModel Exportデータに対応するModelのクラス型
* @param filePath Exportファイル
View
6 thundergate-project/asakusa-thundergate/src/main/java/com/asakusafw/bulkloader/extractor/DfsFileImport.java
@@ -93,9 +93,9 @@ public DfsFileImport() {
* 出力先はプロトコルの形式によって異なる。
* 利用可能なプロトコルは以下のとおり。
* <ul>
- * <li> {@link FileProtocol.Kind#CONTENT} </li>
- * <li> {@link FileProtocol.Kind#CREATE_CACHE} </li>
- * <li> {@link FileProtocol.Kind#UPDATE_CACHE} </li>
+ * <li> {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#CONTENT} </li>
+ * <li> {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#CREATE_CACHE} </li>
+ * <li> {@link com.asakusafw.bulkloader.transfer.FileProtocol.Kind#UPDATE_CACHE} </li>
* </ul>
* @param bean パラメータを保持するBean
* @param user OSのユーザー名
Please sign in to comment.
Something went wrong with that request. Please try again.