Spring/spring-data-redis
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

+ found recipe for generating project javadocs

Browse Source 
+ add javadoc files
This commit is contained in:
Costin Leau
2010-12-03 13:18:25 +02:00
parent fd35d4fe96
commit 4c4017b895
8 changed files with 165 additions and 231 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
pom.xml
View File

@@ -8,6 +8,10 @@
<version>1.0.0.BUILD-SNAPSHOT</version>
<packaging>pom</packaging>
<properties>
<javadoc.loc>src/main/javadoc</javadoc.loc>
</properties>
<modules>
<module>spring-data-keyvalue-parent</module>
<module>spring-data-keyvalue-core</module>
@@ -15,6 +19,7 @@
<module>spring-data-riak</module>
</modules>
<build>
<extensions>
<extension>
@@ -153,7 +158,62 @@
<finalName>${dist.finalName}</finalName>
-->
<plugin>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<id>attach-sources</id>
<phase>pre-site</phase>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version>
<executions>
<execution>
<id>aggregate</id>
<phase>pre-site</phase>
<goals>
<goal>aggregate</goal>
</goals>
</execution>
</executions>
<configuration>
<javadoc:aggregate>true</javadoc:aggregate>
<breakiterator>true</breakiterator>
<header>Spring Data Key-Value</header>
<source>1.5</source>
<show>protected</show>
<quiet>true</quiet>
<javadocDirectory>${javadoc.loc}</javadocDirectory>
<overview>${javadoc.loc}/overview.html</overview>
<stylesheetfile>${javadoc.loc}/javadoc.css</stylesheetfile>
<docfilessubdirs>true</docfilessubdirs>
<groups>
<group>
<title>Spring Data Key Value Core</title>
<packages>org.springframework.data.keyvalue.core*</packages>
</group>
<group>
<title>Spring Data Redis Support</title>
<packages>org.springframework.data.keyvalue.redis*</packages>
</group>
<group>
<title>Spring Data Riak Support</title>
<packages>org.springframework.data.keyvalue.riak*</packages>
</group>
</groups>
<links>
<link>http://static.springframework.org/spring/docs/3.0.x/javadoc-api</link>
<link>http://download.oracle.com/javase/6/docs/api/</link>
</links>
</configuration>
</plugin>
</plugins>
</build>
@@ -163,7 +223,7 @@
<site>
<id>static.springframework.org</id>
<url>
scp://static.springframework.org/var/www/domains/springframework.org/static/htdocs/spring-data/datastore-keyvalue/snapshot-site/
scp://static.springframework.org/var/www/domains/springframework.org/static/htdocs/spring-data/data-keyvalue/snapshot-site/
</url>
</site>
<repository>

70
spring-data-keyvalue-parent/pom.xml
View File

@@ -22,16 +22,24 @@
<org.springframework.version>3.0.5.RELEASE</org.springframework.version>
<!-- dist.* properties are used by the antrun tasks below -->
<dist.id>spring-data-keyvalue</dist.id>
<dist.name>Spring data Key-Value</dist.name>
<dist.key>DATADOC</dist.key>
<dist.name>Spring Data Key-Value</dist.name>
<dist.key>DATAKV</dist.key>
<dist.version>${project.version}</dist.version>
<dist.releaseType>snapshot</dist.releaseType>
<dist.finalName>${dist.id}-${dist.version}</dist.finalName>
<dist.fileName>${dist.finalName}.zip</dist.fileName>
<dist.filePath>target/${dist.fileName}</dist.filePath>
<dist.bucketName>dist.springframework.org</dist.bucketName>
<!-- javadoc -->
<javadoc.loc>../src/main/javadoc</javadoc.loc>
</properties>
<organization>
<name>SpringSource</name>
<url>http://www.SpringSource.org</url>
</organization>
<developers>
<developer>
@@ -57,7 +65,6 @@
</roles>
<timezone>+2</timezone>
</developer>
</developers>
<licenses>
@@ -394,48 +401,6 @@
</archive>
</configuration>
</plugin>
<!--
<plugin>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.5</version>
<executions>
<execution>
<id>aggregate</id>
<goals>
<goal>aggregate</goal>
</goals>
<phase>package</phase>
<configuration>
<javadoc:aggregate>true</javadoc:aggregate>
<breakiterator>true</breakiterator>
<header>Spring data Key-Value</header>
<source>1.5</source>
<quiet>true</quiet>
<javadocDirectory>${project.basedir}/src/main/javadoc</javadocDirectory>
<overview>${project.basedir}/src/main/javadoc/overview.html</overview>
<stylesheetfile>${project.basedir}/src/main/javadoc/spring-javadoc.css</stylesheetfile>
<docfilessubdirs>true</docfilessubdirs>
<links>
<link>http://static.springframework.org/spring/docs/3.0.x/javadoc-api</link>
<link>http://java.sun.com/javase/6/docs/api</link>
</links>
</configuration>
</execution>
</executions>
</plugin>
-->
</plugins>
<pluginManagement>
<plugins>
@@ -486,6 +451,21 @@
</execution>
</executions>
</plugin>
<!--
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version>
<executions>
<execution>
<id>aggregate</id>
<phase>pre-site</phase>
<goals>
<goal>aggregate</goal>
</goals>
</execution>
</executions>
</plugin>
-->
</plugins>
</pluginManagement>
</build>

8
src/assembly/distribution.xml
View File

@@ -42,8 +42,8 @@
<moduleSet>
<!-- adds module jars to the distribution archive under the 'dist' directory -->
<includes>
<include>org.springframework.data:spring-datastore-keyvalue-core</include>
<include>org.springframework.data:spring-datastore-redis</include>
<include>org.springframework.data:spring-data-keyvalue-core</include>
<include>org.springframework.data:spring-data-redis</include>
</includes>
<binaries>
<outputDirectory>dist</outputDirectory>
@@ -55,8 +55,8 @@
<!-- adds module source jars to the distribution archive under the 'src' directory
see pom.xml 'maven-source-plugin' declaration -->
<includes>
<include>org.springframework.data:spring-datastore-keyvalue-core</include>
<include>org.springframework.data:spring-datastore-redis</include>
<include>org.springframework.data:spring-data-keyvalue-core</include>
<include>org.springframework.data:spring-data-redis</include>
</includes>
<binaries>
<attachmentClassifier>sources</attachmentClassifier>

2
src/docbkx/index.xml
View File

@@ -3,7 +3,7 @@
<book xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Spring Datastore Key-Value - Reference Documentation</title>
<title>Spring Data Key-Value - Reference Documentation</title>
<releaseinfo>&version;</releaseinfo>
<authorgroup>

2
src/docbkx/preface.xml
View File

@@ -4,7 +4,7 @@
<preface id="preface">
<title>Preface</title>
<para>The Spring Datastore Key-Value project applies core Spring concepts to the development of solutions using a key-value style data store.
<para>The Spring Data Key-Value project applies core Spring concepts to the development of solutions using a key-value style data store.
We provide a "template" as a high-level abstraction for sending and receiving messages.
You will notice similarities to the JDBC support in the Spring Framework.
</para>

48
src/main/javadoc/javadoc.css Normal file
View File

@@ -0,0 +1,48 @@
/* Spring-specific Javadoc style sheet rules */
#overviewBody {
}
.code {
border: 1px solid black;
background-color: #F4F4F4;
padding: 5px;
}
/* Vanilla Javadoc style sheet rules */
body {
font-family: Helvetica, Arial, sans-serif;
background-color: white;
font-size: 10pt;
}
td { font-size: 10pt; font-family: Helvetica, Arial, sans-serif }/* Javadoc style sheet */
/* Define colors, fonts and other style attributes here to override the defaults */
/* Page background color */
body { background-color: #FFFFFF }
/* Headings */
h1 { font-size: 145% }
/* Table colors */
.TableHeadingColor { background: #CCCCFF } /* Dark mauve */
.TableSubHeadingColor { background: #EEEEFF } /* Light mauve */
.TableRowColor { background: #FFFFFF } /* White */
/* Font used in left-hand frame lists */
.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif }
.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
/* Navigation bar fonts and colors */
.NavBarCell1 { background-color:#EEEEFF;} /* Light mauve */
.NavBarCell1Rev { background-color:#00008B;} /* Dark Blue */
.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;}
.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}

24
src/main/javadoc/overview.html Normal file
View File

@@ -0,0 +1,24 @@
<html>
<body>
This document is the API specification for the Spring Data project.
<hr/>
<div id="overviewBody">
<!--
<p>
For further API reference and developer documentation, see the
<a href="http://static.springframework.org/spring/docs/2.0.x/reference/index.html" target="_top">Spring Framework reference documentation</a>.
That documentation contains more detailed, developer-targeted
descriptions, with conceptual overviews, definitions of terms,
workarounds, and working code examples.
</p>
-->
<p>
If you are interested in commercial training, consultancy and
support for the Spring Data Framework,
<a href="http://www.SpringSource.com/" target="_top">SpringSource</a> provides
such commercial support.
</p>
</div>
</body>
</html>

178
src/main/javadoc/spring-javadoc.css
View File

@@ -1,178 +0,0 @@
/* stylesheet.css 2008/04/22 nicolekonicki */
/*
*
* Spring-specific Javadoc style sheet
*
*/
.code
{
border: 1px solid black;
background-color: #F4F4F4;
padding: 5px;
}
body
{
font: 12px Verdana, Arial, Helvetica, "Bitstream Vera Sans", sans-serif;
background-color: #fff;
color: #333;
}
/* Link colors */
a
{
color:#2c7b14;
text-decoration:none;
}
a:hover
{
text-decoration:underline;
}
/* Headings */
h1
{
font-size:28px;
color:#007c00;
}
/* Table colors */
table
{
border:none;
}
td
{
border:none;
border-bottom:1px dotted #ddd;
}
th
{
border:none;
}
.TableHeadingColor th
{
background-color: #efffcb;
background-image: url(doc-files/th-background.png);
background-repeat: repeat-x;
color:#fff;
font-size:14px;
height:26px;
}
.TableSubHeadingColor
{
background: #f7ffee;
}
.TableRowColor
{
background: #fff;
}
.TableRowColor a
{
border-bottom:none;
color:#2c7b14;
font-weight:normal;
}
tr.TableRowColor:hover
{
background:#eef2e1;
}
/* Font used in left-hand frame lists */
.FrameTitleFont
{
font-size: 120%;
font-weight:bold;
}
.FrameTitleFont a
{
color: #333;
}
.FrameHeadingFont
{
font-weight: bold;
font-size:95%;
}
.FrameItemFont
{
line-height:130%;
font-size: 95%;
}
.FrameItemFont a
{
color:#333;
}
.FrameItemFont a:hover
{
color:#249901;
border-bottom:none;
text-decoration:underline;
}
/* Navigation bar fonts and colors */
.NavBarCell1
{
background-color:#fff;
border:none;
}
.NavBarCell1Rev
{
background-color:#e3faa5;
border:1px solid #9ad00c;
padding:0;
margin:0;
}
.NavBarCell1 a
{
color:#333;
text-decoration:none;
}
.NavBarFont1Rev
{
}
.NavBarCell2
{
border:none;
}
.NavBarCell2 a
{
color:#249901;
font-size:90%;
}
.NavBarCell3
{
border:none;
}
/* Override sizes in font tags */
font
{
font: inherit !important;
}