Mavenでscaladocを作る
maven-scala-pluginでは、scaladocの作成もサポートされています。手順は次の通り。
- pom.xmlの「reporting」にmaven-scala-pluginの設定を書く
- 「mvn scala:doc」!
1.pom.xmlにmaven-scala-pluginの設定を書く。
pom.xmlの「project/reporting」に以下の設定を追加します。
- 「configuration」でscalaのバージョンを「2.7.1」にしておくこと。
- maven-scala-pluginの取得先の設定も必要です。
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> ... <reporting> <!-- scalaプラグインを追加 --> <plugins> <plugin> <groupId>org.scala-tools</groupId> <artifactId>maven-scala-plugin</artifactId> <!-- バージョンは2.7.1とする。設定しないとエラーになる --> <configuration> <scalaVersion>2.7.1</scalaVersion> </configuration> </plugin> </plugins> </reporting> ... <!-- プラグインの取得先リポジトリの設定 --> <repositories> <repository> <id>scala-tools.org</id> <name>Scala-tools Maven2 Repository</name> <url>http://scala-tools.org/repo-releases</url> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>scala-tools.org</id> <name>Scala-tools Maven2 Repository</name> <url>http://scala-tools.org/repo-releases</url> </pluginRepository> </pluginRepositories> ... </project>
2.Mavenのコマンドを実行
あとは
mvn scala:doc
で「src/main/scala」以下のソースコードを元に、scaladocが「target/site/scaladocs」以下に作成されます。
補足:scaladocの書き方
scaladocの書き方については、scaladocツールの解説を参照。JavaDocと似た感じです。