How to generate the JavaDocs with Maven 2
=========================================
This process is to be repeated on every major release to generate a full new set of javadocs.
1.- Checkout the "tag" you want to generate the javadocs from, for example
svn co https://svn.apache.org/repos/asf/geronimo/server/tags/2.1.3/ /Apache/tags-2.1.3
2.- Create a style sheet file with the following content, for example /Apache/apidocs.css
/* Page background color */
body { background-color: #FFFFFF; font-family: Helvetica, Arial, sans-serif; }
/* Link colors */
A:link, A:visited, A:active, A:hover { color: #003366; }
/* Headings */
h1 { font-size: 20px; }
h2 { font-size: 18px; }
h3 { font-size: 14px; }
h4 { font-size: 12px; }
/* Table colors */
.TableHeadingColor { background: #5FA3D6 } /* Light Blue */
.TableSubHeadingColor { background: #F0F0F0 } /* Grey */
.TableRowColor { background: #F3F4F5 } /* Lighter Grey */
/* 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:#F3F4F5;} /* Lighter Grey */
.NavBarCell1Rev { background-color:#5FA3D6;} /* Light 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;}
3.- Generate javadocs with Maven 2 using the following command from the "tags/x.y.z" directory.
For example:
/Apache/tags-2.1.3/>mvn javadoc:javadoc -Daggregate=true -Dstylesheetfile="/Apache/apidocs.css"
4.- The previous command will generate a "target/site/apidocs" directory with all the generated HTML javadocs.
On this directory create a "header.html" file with the following content.
5.- Modify the "index.html" frameset to include the header.html you just created. Here is an example.
Geronimo 2.1.3 API
6.- Copy the completed javadoc to /www/geronimo.apache.org - for example:
ssh to people.apache.org
cd /www/geronimo.apache.org/docs/apidocs
mkdir 2.1.3
and copy the javadocs you just created there.
7.- As the items are synced with the mirrors it will go live.
8.- Update the javadocs wiki page to add a link for the for the newly generated javadocs.
GMOxSITE/Javadoc
