Permalink
Browse files

OGM-246 Distribution does not contain JavaDoc

  • Loading branch information...
Sanne authored and emmanuelbernard committed Sep 28, 2012
1 parent 7eba06e commit 798af28c45e4ddb1f3b5daa871274b86c5f7366c
View
@@ -113,44 +113,13 @@
<skipExec>${skipUnitTests}</skipExec>
</configuration>
</plugin>
- <plugin>
- <groupId>org.bsc.maven</groupId>
- <artifactId>maven-processor-plugin</artifactId>
- </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <tags>
- <tag>
- <name>experimental</name>
- <placement>a</placement>
- <head>Experimental</head>
- </tag>
- </tags>
- <docfilessubdirs>true</docfilessubdirs>
- <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
- <links>
- <link>http://download.oracle.com/javase/6/docs/api/</link>
- <link>http://docs.jboss.org/hibernate/orm/4.1/javadocs/</link>
- <link>http://docs.jboss.org/hibernate/search/4.1/api/</link>
- <link>http://lucene.apache.org/core/old_versioned_docs/versions/3_5_0/api/all/</link>
- </links>
- <packagesheader>Hibernate OGM Packages</packagesheader>
- <doctitle>Hibernate OGM ${project.version}</doctitle>
- <windowtitle>Hibernate OGM ${project.version}</windowtitle>
- <bottom>
- <![CDATA[Copyright &copy; ${project.inceptionYear}-{currentYear} <a href="http://redhat.com">Red Hat Middleware, LLC</a>, Emmanuel Bernard and various contributors. All Rights Reserved]]></bottom>
- </configuration>
- <executions>
- <execution>
- <id>attach-javadocs</id>
- <phase>deploy</phase>
- <goals>
- <goal>jar</goal>
- </goals>
- </execution>
- </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.bsc.maven</groupId>
+ <artifactId>maven-processor-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.jboss.maven.plugins</groupId>
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Hibernate, Relational Persistence for Idiomatic Java
+ ~
+ ~ JBoss, Home of Professional Open Source
+ ~ Copyright 2012 Red Hat Inc. and/or its affiliates and other contributors
+ ~ as indicated by the @authors tag. All rights reserved.
+ ~ See the copyright.txt in the distribution for a
+ ~ full listing of individual contributors.
+ ~
+ ~ This copyrighted material is made available to anyone wishing to use,
+ ~ modify, copy, or redistribute it subject to the terms and conditions
+ ~ of the GNU Lesser General Public License, v. 2.1.
+ ~ This program is distributed in the hope that it will be useful, but WITHOUT A
+ ~ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ ~ PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ ~ You should have received a copy of the GNU Lesser General Public License,
+ ~ v.2.1 along with this distribution; if not, write to the Free Software
+ ~ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ ~ MA 02110-1301, USA.
+ -->
+<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/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.hibernate.ogm</groupId>
+ <artifactId>hibernate-ogm-documentation</artifactId>
+ <version>4.0.0-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+
+ <groupId>org.hibernate.ogm</groupId>
+ <artifactId>hibernate-ogm-javadoc</artifactId>
+ <packaging>jar</packaging>
+
+ <name>Hibernate OGM Javadoc</name>
+ <description>Hibernate OGM helper module to build aggregated javadoc</description>
+
+ <properties>
+ <!-- Skip artifact deployment -->
+ <maven.deploy.skip>true</maven.deploy.skip>
+ </properties>
+
+ <!-- We need the dependencies having annotations we're using
+ to workaround a javadoc tool bug -->
+ <dependencies>
+ <dependency>
+ <groupId>org.hibernate</groupId>
+ <artifactId>hibernate-entitymanager</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.hibernate</groupId>
+ <artifactId>hibernate-search-orm</artifactId>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourcepath>
+ ${basedir}/../../hibernate-ogm-core/src/main/java;
+ ${basedir}/../../hibernate-ogm-ehcache/src/main/java;
+ ${basedir}/../../hibernate-ogm-infinispan/src/main/java;
+ ${basedir}/../../hibernate-ogm-mongodb/src/main/java
+ </sourcepath>
+ <tags>
+ <tag>
+ <name>experimental</name>
+ <placement>a</placement>
+ <head>Experimental</head>
+ </tag>
+ </tags>
+ <docfilessubdirs>true</docfilessubdirs>
+ <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
+ <links>
+ <link>http://download.oracle.com/javase/6/docs/api/</link>
+ <link>http://docs.jboss.org/hibernate/orm/4.1/javadocs/</link>
+ <link>http://docs.jboss.org/hibernate/search/4.2/api/</link>
+ <link>http://lucene.apache.org/java/3_6_1/api/all</link>
+ </links>
+ <packagesheader>Hibernate OGM Packages</packagesheader>
+ <doctitle>Hibernate OGM ${project.version}</doctitle>
+ <windowtitle>Hibernate OGM ${project.version}</windowtitle>
+ <bottom>
+ <![CDATA[Copyright &copy; ${project.inceptionYear}-{currentYear} <a href="http://redhat.com">Red Hat Middleware, LLC</a>, Emmanuel Bernard and various contributors. All Rights Reserved]]></bottom>
+ </configuration>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <phase>install</phase>
+ <goals>
+ <goal>javadoc</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>bundle-javadocs</id>
+ <phase>package</phase>
+ <goals>
+ <goal>javadoc</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
@@ -45,6 +45,7 @@
<modules>
<module>manual</module>
<module>examples</module>
+ <module>javadoc</module>
</modules>
</project>
@@ -108,6 +108,10 @@
<skipExec>${skipUnitTests}</skipExec>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
<plugin>
<groupId>org.bsc.maven</groupId>
<artifactId>maven-processor-plugin</artifactId>
@@ -148,6 +148,10 @@
<skipExec>${skipUnitTests}</skipExec>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
<plugin>
<groupId>org.bsc.maven</groupId>
<artifactId>maven-processor-plugin</artifactId>
@@ -26,6 +26,10 @@
<forkMode>once</forkMode>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
<plugin>
<groupId>org.bsc.maven</groupId>
<artifactId>maven-processor-plugin</artifactId>
View
16 pom.xml
@@ -565,6 +565,17 @@
</plugins>
<pluginManagement>
<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.9</version>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals><goal>jar</goal></goals>
+ </execution>
+ </executions>
+ </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
@@ -719,11 +730,6 @@
<artifactId>maven-injection-plugin</artifactId>
<version>1.0.2</version>
</plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.8.1</version>
- </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
View
@@ -46,12 +46,6 @@
</includes>
<sources>
<includeModuleDirectory>false</includeModuleDirectory>
- <fileSets>
- <fileSet>
- <directory>target/apidocs</directory>
- <outputDirectory>docs/api</outputDirectory>
- </fileSet>
- </fileSets>
</sources>
<binaries>
<outputDirectory>dist</outputDirectory>
@@ -96,12 +90,6 @@
</includes>
<sources>
<includeModuleDirectory>false</includeModuleDirectory>
- <fileSets>
- <fileSet>
- <directory>target/apidocs</directory>
- <outputDirectory>docs/api</outputDirectory>
- </fileSet>
- </fileSets>
</sources>
<binaries>
<outputDirectory>dist/lib/infinispan</outputDirectory>
@@ -142,12 +130,6 @@
</includes>
<sources>
<includeModuleDirectory>false</includeModuleDirectory>
- <fileSets>
- <fileSet>
- <directory>target/apidocs</directory>
- <outputDirectory>docs/api</outputDirectory>
- </fileSet>
- </fileSets>
</sources>
<binaries>
<outputDirectory>dist/lib/infinispan</outputDirectory>
@@ -169,12 +151,6 @@
</includes>
<sources>
<includeModuleDirectory>false</includeModuleDirectory>
- <fileSets>
- <fileSet>
- <directory>target/apidocs</directory>
- <outputDirectory>docs/api</outputDirectory>
- </fileSet>
- </fileSets>
</sources>
<binaries>
<outputDirectory>dist/lib/infinispan</outputDirectory>
@@ -201,12 +177,6 @@
</includes>
<sources>
<includeModuleDirectory>false</includeModuleDirectory>
- <fileSets>
- <fileSet>
- <directory>target/apidocs</directory>
- <outputDirectory>docs/api</outputDirectory>
- </fileSet>
- </fileSets>
</sources>
<binaries>
<outputDirectory>dist/lib/ehcache</outputDirectory>
@@ -257,12 +227,6 @@
</includes>
<sources>
<includeModuleDirectory>false</includeModuleDirectory>
- <fileSets>
- <fileSet>
- <directory>target/apidocs</directory>
- <outputDirectory>docs/api</outputDirectory>
- </fileSet>
- </fileSets>
</sources>
<binaries>
<outputDirectory>dist/lib/mongodb</outputDirectory>
@@ -300,6 +264,26 @@
</binaries>
</moduleSet>
+ <!--
+ #######################################################################
+ # API Javadoc
+ #######################################################################
+ -->
+ <moduleSet>
+ <includes>
+ <include>org.hibernate.ogm:hibernate-ogm-javadoc</include>
+ </includes>
+ <sources>
+ <includeModuleDirectory>false</includeModuleDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>target/site/apidocs</directory>
+ <outputDirectory>docs/api</outputDirectory>
+ </fileSet>
+ </fileSets>
+ </sources>
+ </moduleSet>
+
</moduleSets>
<files>

0 comments on commit 798af28

Please sign in to comment.