Added a JavaDoc stylesheet customization that adds a 'code' style class to pre tags.

svn changeset:11679/svn branch:6.3

diff --git a/build/build.xml b/build/build.xml
index 3d00e344ad911deb2d3f9810f127baa5de3381c1..88eec32fd3baa03dba25c2709be738482710c8fd 100644 (file)
--- a/build/build.xml
+++ b/build/build.xml
@@ -16,9 +16,7 @@
      * vaadin-oophm-<version>.zip
     -->
 
-    <!-- 
-    Call one of package-* targets unless you understand what you are doing 
-    -->
+    <!--Call one of package-* targets unless you understand what you are doing. -->
     <target name="package-all" depends="clean-all, package-init, init, build, docs, internal-package-zip, internal-package-war, internal-package-liferay" description="Build public packages.">
     </target>
 
@@ -448,11 +446,17 @@
             <filter token="ITMillApache2LicenseForJavaFiles" value="${ITMillApache2LicenseForJavaFiles}" />
             <filter token="VERSION" value="${version.full}" />
         </filterset>
+       
+       <!-- Adds a style class to JavaDoc <pre> tags for style customization. -->
+        <filterset id="pre-css-style" begintoken="     * &lt;" endtoken="&gt;">
+            <filter token="pre" value="     * &lt;pre class='code'&gt;" />
+        </filterset>
 
         <echo>Copying src directory and processing copied files.</echo>
         <echo>Replacing &lt;version&gt; tag with build version for java/html/css/xml files.</echo>
-        <copy todir="${result-path}/src/core">
+        <copy todir="${result-path}/src/core" overwrite="yes">
                <filterset refid="version-and-license"/>
+            <filterset refid="pre-css-style"/>
             <fileset dir="src">
                 <patternset refid="preprocessable-files" />
             </fileset>
@@ -465,7 +469,6 @@
             </fileset>
         </copy>
 
-
                <antcontrib:if>
                        <isset property="build.include.tests"/>
                        <then>
@@ -976,7 +979,9 @@
     <!-- Documentation: Add Javadoc to doc                                  -->
     <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  -->
     <target name="javadoc" depends="init, preprocess-src">
-        <javadoc destdir="${output-dir}/WebContent/docs/api" author="true" version="true" use="true" windowtitle="${product-name}" classpathref="compile.classpath.client-side">
+        <property name="javadoc.destdir" value="${output-dir}/WebContent/docs/api"/>
+       
+        <javadoc destdir="${javadoc.destdir}" author="true" version="true" use="true" windowtitle="${product-name}" classpathref="compile.classpath.client-side">
             <packageset dir="${result-path}/src/core">
                 <include name="${toolkit-package}/**" />
             </packageset>
@@ -986,6 +991,12 @@
             <link offline="true" href="http://java.sun.com/j2se/1.5.0/docs/api/" packagelistLoc="build/javadoc/j2se-1.5.0" />
             <link offline="true" href="http://java.sun.com/j2ee/1.4/docs/api/" packagelistLoc="build/javadoc/j2ee-1.4" />
         </javadoc>
+
+        <!-- Append local style definitions. -->
+        <echo>Appending local style definitions</echo>
+        <concat destfile="${javadoc.destdir}/stylesheet.css" append="yes">
+            <filelist dir="build/javadoc" files="stylesheet-local.css"/>
+        </concat>
     </target>
 
     <!-- java2html converter -->

diff --git a/build/javadoc/stylesheet-local.css b/build/javadoc/stylesheet-local.css
new file mode 100644 (file)
index 0000000..ae1fb5c
--- /dev/null
+++ b/build/javadoc/stylesheet-local.css
@@ -0,0 +1,14 @@
+
+/***********************************************************************/
+/* Custom Vaadin API JavaDoc style definitions                         */
+/*                                                                     */
+/* This stylesheet is appended to the generated JavaDoc stylesheet.css */
+/***********************************************************************/
+
+/* As Eclipse forces a newline before the ending </pre> tag, we need
+   to compensate for the extra line. This requires that the 'code'
+   style class is inserted into the source files as JavaDoc does
+   not add any particular style in the generated files. */
+pre.code {
+       margin-bottom: -1.5em;
+}