#28 publish javadoc to github

joachimvda · Sep 9, 2013 · 7102b8d · 7102b8d
1 parent 5ba35b8
commit 7102b8d
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,8 @@
 jtransfo
 ========
 
-Convert between data and transfer objects
+Convert between data and transfer objects.
+
+[Main site with documentation](http://jtransfo.org)
+
+[javadoc](http://joachimvda.github.io/jtransfo/)
diff --git a/pom.xml b/pom.xml
@@ -218,21 +218,40 @@
 					</archive>
 				</configuration>
 			</plugin>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>2.8</version>
-				<configuration>
-					<show>public</show>
-					<nohelp>true</nohelp>
-					<header>jTransfo, ${project.name} ${project.version}</header>
-					<footer>jTransfo, ${project.name} ${project.version}</footer>
-					<links>
-						<link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
-					</links>
-				</configuration>
-			</plugin>
-			<plugin>
+
+            <!-- to publish javadoc, use "mvn clean javadoc:javadoc scm-publish:publish-scm" -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>2.9.1</version>
+                <configuration>
+                    <aggregate>true</aggregate>
+                    <show>public</show>
+                    <nohelp>true</nohelp>
+                    <header>jTransfo, ${project.version}</header>
+                    <footer>jTransfo, ${project.version}</footer>
+                    <doctitle>jTransfo, ${project.version}</doctitle>
+                    <links>
+                        <link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
+                    </links>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-scm-publish-plugin</artifactId>
+                <version>1.0-beta-2</version>
+                <configuration>
+                    <checkoutDirectory>${project.build.directory}/scmpublish</checkoutDirectory>
+                    <checkinComment>Publishing javadoc for ${project.artifactId}:${project.version}</checkinComment>
+                    <!-- Plugins defaults to "target/staging" and since the distributionManagement section is a pain in the ass for site docs, this is easier -->
+                    <content>${project.reporting.outputDirectory}/apidocs</content>
+                    <skipDeletedFiles>true</skipDeletedFiles>
+                    <pubScmUrl>scm:git:git@github.com:joachimvda/jtransfo.git</pubScmUrl>
+                    <scmBranch>gh-pages</scmBranch> <!-- branch with static site -->
+                </configuration>
+            </plugin>
+
+            <plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-source-plugin</artifactId>
 				<version>2.2.1</version>

diff --git a/spring/src/main/java/org/jtransfo/spring/JTransfoSpring.java b/spring/src/main/java/org/jtransfo/spring/JTransfoSpring.java
@@ -13,8 +13,8 @@
 import org.jtransfo.TypeConverter;
 import org.springframework.beans.factory.annotation.Autowired;
 
-import javax.annotation.PostConstruct;
 import java.util.List;
+import javax.annotation.PostConstruct;
 
 /**
  * Spring implementation of {@link org.jtransfo.JTransfo}.