Merge pull request #225 from domaframework/doc-intellij

Add documents for IntelliJ IDEA

Author: nakamura-to

docs/sources/annotation-processing.rst

@@ -84,6 +84,11 @@ Eclipse
 
 プロジェクトの「Properties」-「Java Compiler」-「Annotation Processing」の項目でオプションを登録します。
 
+IntelliJ IDEA
+=============
+
+Preferrences から Build, Execution, Deployment > Compiler > Annotation Processors の画面を開き登録します。
+
 javac
 =====
 

docs/sources/build.rst

@@ -14,6 +14,8 @@ GroupId と ArtifactId の名称は以下の通りです。
 :GroupId: org.seasar.doma
 :ArtifactId: doma
 
+.. _eclipse-build:
+
 Eclipse を使ったビルド
 ======================
 
@@ -56,6 +58,17 @@ Factory Path の設定
 
 |
 
+IntelliJ IDEA を使ったビルド
+================================
+
+IntelliJ IDEA でビルドを行う際のポイントは以下の通りです。
+
+* Module の設定で Inherit project compile output pathを有効にする
+* Preferences の設定で注釈処理を有効にする
+* 注釈処理で生成されたコードが出力されるディレクトリを Generated Sources Root に設定する
+
+詳細な設定方法については :ref:`idea-annotation-processor` を参照してください。
+
 Gradle を使ったビルド
 =====================
 

docs/sources/faq.rst

@@ -31,7 +31,7 @@ Domaでは、注釈処理を使用して以下のことを実現しています
 どのバージョンのJREをサポートしていますか？
 -------------------------------------------
 
-JER 8 以上をサポートしています。
+JER 8、9、10 をサポートしています。
 
 Domaを動作させるのに必要なライブラリは何ですか？
 ------------------------------------------------
@@ -45,12 +45,12 @@ DomaはJRE以外のどんなライブラリにも依存していません。
 どのバージョンのJDKをサポートしていますか？
 -------------------------------------------
 
-JDK 8 以上をサポートしています。
+JDK 8、9、10 をサポートしています。
 
 推奨されたIDE（統合開発環境）はありますか？
 -------------------------------------------
 
-Eclipse です。
+Eclipse と IntelliJ IDEA です。
 
 DomaのjarをEclipseのビルドパスに設定しましたが注釈処理が実行されません。
 ------------------------------------------------------------------------

docs/sources/getting-started.rst renamed to docs/sources/getting-started-eclipse.rst

@@ -1,6 +1,6 @@
-=======================
-Getting Started
-=======================
+===============================
+はじめよう！ (Eclipse)
+===============================
 
 .. contents:: 目次
    :depth: 3
@@ -10,32 +10,29 @@ Getting Started
 
 開発環境のセットアップ方法と基本的なデータベースアクセスの実行方法を紹介します。
 
-.. _IntelliJ Doma support plugin: https://github.com/siosio/DomaSupport
-
-.. note::
-
-  このドキュメントでは、IDE として Eclipse を用いますが、
-  Eclipse の代わりに IntelliJ IDEA を利用して開発することも可能です。
-  IntelliJ IDEA を利用する場合は、 `IntelliJ Doma support plugin`_ の併用をお奨めします。
-
 JDK のインストール
 ==================
 
 .. _JDK 8: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
 
 `JDK 8`_ をインストールしてください。
 
+.. note::
+
+  JDK 9 や JDK 10 もサポートされています。
+
 Eclipse のインストール
 ======================
 
-.. _Eclipse Standard 4.4: http://www.eclipse.org/downloads/
+.. _Eclipse: http://www.eclipse.org/downloads/
 
-`Eclipse Standard 4.4`_ をインストールしてください。
+`Eclipse`_ をインストールしてください。
 
 .. note::
 
   Eclipse IDE for Java EE Developers など他のパッケージでも動作しますが
-  このドキュメントでは Eclipse Standard を対象とします。
+  このドキュメントでは Eclipse Standard 4.4 で動作確認しています。
+  上位のバージョンでも動作すると思われます。
 
 Eclipse プラグイン Doma Tools のインストール
 ============================================
@@ -116,9 +113,14 @@ clone されたディレクトリに移動します。
 
 .. note::
 
-  環境変数 ``JAVA_HOME`` に JDK 8 をインストールしたディレクトリを設定しておいてください。
+  環境変数 ``JAVA_HOME`` に JDK 8 （もしくは JDK 9 や 10）をインストールしたディレクトリを設定しておいてください。
   gradlew の実行に必要です。
 
+.. note::
+
+  Eclipse 用の設定ファイルには注釈処理の設定が含まれます。
+  手動で設定する場合は、 :ref:`eclipse-build` を参照ください。
+
 
 Eclipse のメニューからFile > Import... を実行し
 'Existing Projects into Workspace' を選んで simple-boilerplate をインポートします。