directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject directory-fortress-core git commit: FC-73 - jdk 8 doclint corrective steps
Date Tue, 03 Mar 2015 05:40:29 GMT
Repository: directory-fortress-core
Updated Branches:
  refs/heads/master e5b197cc6 -> 6e7368fd4


FC-73 - jdk 8 doclint corrective steps


Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/6e7368fd
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/6e7368fd
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/6e7368fd

Branch: refs/heads/master
Commit: 6e7368fd417f877f2eddf9b08c727e852a97d9cf
Parents: e5b197c
Author: Shawn McKinney <smckinney@apache.org>
Authored: Mon Mar 2 23:40:11 2015 -0600
Committer: Shawn McKinney <smckinney@apache.org>
Committed: Mon Mar 2 23:40:11 2015 -0600

----------------------------------------------------------------------
 .../core/doc-files/apache-fortress-rest.html    | 12 +++++++
 .../core/doc-files/ten-minute-guide.html        | 35 +++++++++++++++-----
 2 files changed, 38 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/6e7368fd/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
index d7ac790..c749cb4 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
@@ -115,6 +115,18 @@ mvn javadoc:javadoc
                 </pre>
         Point your web browser to the following location:
         file:///[directory-fortress-enmasse]/target/site/apidocs.
+        <br><br>
+        javadoc note: If using JDK 8, you must turn off doclint to get past errors.  Add
the following to project's pom:
+                <pre>
+                    <p style="font: monospace; color: black; background-color: lightgrey;
font-size: 10pt">
+&lt;plugin&gt;
+    &lt;artifactId&gt;maven-javadoc-plugin&lt;/artifactId&gt;
+    &lt;configuration&gt;
+        &lt;additionalparam&gt;-Xdoclint:none&lt;/additionalparam&gt;
+    &lt;/configuration&gt;
+&lt;/plugin&gt;
+                    </p>
+                </pre>
     </li>
 
 </ol>

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/6e7368fd/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
index 5f659f6..5cafe18 100644
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
@@ -98,21 +98,38 @@ mvn clean install -DskipTests
 mvn javadoc:javadoc
                     </p>
                 </pre>
-        note: if using java 8, add this param to the pom.xml:
+
+        javadoc note: If using JDK 8, you must turn off doclint to get past errors.  Add
the following to project's pom:
                 <pre>
                     <p style="font: monospace; color: black; background-color: lightgrey;
font-size: 10pt">
-plugin
-...
-artifactId maven-javadoc-plugin /artifactId
-configuration
-&lt;additionalparam&gt;-Xdoclint:none&lt;additionalparam/&gt;
-...
-configuration
-plugin
+&lt;plugin&gt;
+    &lt;artifactId&gt;maven-javadoc-plugin&lt;/artifactId&gt;
+    &lt;configuration&gt;
+        &lt;additionalparam&gt;-Xdoclint:none&lt;/additionalparam&gt;
+    &lt;/configuration&gt;
+&lt;/plugin&gt;
                     </p>
                 </pre>
     </li>
 
+    <!--plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>${javadoc.version}</version>
+        <configuration>
+            <additionalparam>-Xdoclint:none</additionalparam>
+            <stylesheet>java</stylesheet>
+            <bottom>&lt;small&gt;Copyright &amp;copy; 2003-2015, The Apache
Software Foundation. All Rights Reserved. Generated ${maven.build.timestamp}&lt;/small&gt;</bottom>
+            <overview>src/main/java/org/apache/directory/fortress/core/overview.html</overview>
+            <docfilessubdirs>true</docfilessubdirs>
+            <includes></includes>
+            <version>true</version>
+            <author>true</author>
+            <doctitle>Fortress Identity and Access Management Javadoc ${version}</doctitle>
+            <windowtitle>Apache Fortress Identity and Access Management Javadoc ${version}</windowtitle>
+        </confsiguration>
+    </plugin-->
+
     <li>Point your web browser to the javadoc:
         <br>file:///[directory-fortress-core]/target/site/apidocs/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html.
         <br><br>Where [directory-fortress-core] is base folder of the fortress
core source package.


Mime
View raw message