You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2015/03/02 08:04:00 UTC
directory-fortress-core git commit: FC-73 - Fix javadoc problems
Repository: directory-fortress-core
Updated Branches:
refs/heads/master 0bd3c06be -> e5b197cc6
FC-73 - Fix javadoc problems
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/e5b197cc
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/e5b197cc
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/e5b197cc
Branch: refs/heads/master
Commit: e5b197cc69d73a0535304d1f694885f54a424f68
Parents: 0bd3c06
Author: Shawn McKinney <sm...@apache.org>
Authored: Mon Mar 2 01:03:44 2015 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Mon Mar 2 01:03:44 2015 -0600
----------------------------------------------------------------------
README-TEN-MINUTE-GUIDE.txt | 10 ++++++++++
README.txt | 18 ++++++++++++++----
.../fortress/core/doc-files/ten-minute-guide.html | 13 +++++++++++++
3 files changed, 37 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/e5b197cc/README-TEN-MINUTE-GUIDE.txt
----------------------------------------------------------------------
diff --git a/README-TEN-MINUTE-GUIDE.txt b/README-TEN-MINUTE-GUIDE.txt
index 825e191..ffe777b 100644
--- a/README-TEN-MINUTE-GUIDE.txt
+++ b/README-TEN-MINUTE-GUIDE.txt
@@ -61,6 +61,16 @@ cd directory-fortress-core/
mvn clean install -DskipTests
mvn javadoc:javadoc
+javadoc note: if using java 8, add this param to the pom.xml:
+<plugin>
+ ...
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <additionalparam>-Xdoclint:none</additionalparam>
+ ...
+ </configuration>
+</plugin>
+
5. Point your web browser to the following location:
file:///[directory-fortress-core]/target/site/apidocs/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/e5b197cc/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
index fb74252..ffeb6dc 100755
--- a/README.txt
+++ b/README.txt
@@ -151,10 +151,6 @@ b. from the FORTRESS_HOME root folder, enter the following command:
# mvn install -DskipTests
-d. from the FORTRESS_HOME root folder, enter the following command:
-
-# mvn javadoc:javadoc
-
install notes:
- Fortress source modules will be compiled along with production of java archive (jar)
@@ -162,6 +158,20 @@ install notes:
- Project artifacts are loaded into $FORTRESS_HOME/target location.
+d. from the FORTRESS_HOME root folder, enter the following command:
+
+# mvn javadoc:javadoc
+
+javadoc note: if using java 8, add this param to the pom.xml:
+<plugin>
+ ...
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <additionalparam>-Xdoclint:none</additionalparam>
+ ...
+ </configuration>
+</plugin>
+
___________________________________________________________________________________
###################################################################################
# SECTION 4. Instructions to build software distribution packages using ant 'dist' target.
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/e5b197cc/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 9f510fb..5f659f6 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,6 +98,19 @@ mvn clean install -DskipTests
mvn javadoc:javadoc
</p>
</pre>
+ note: if using java 8, add this param to the pom.xml:
+ <pre>
+ <p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
+plugin
+...
+artifactId maven-javadoc-plugin /artifactId
+configuration
+<additionalparam>-Xdoclint:none<additionalparam/>
+...
+configuration
+plugin
+ </p>
+ </pre>
</li>
<li>Point your web browser to the javadoc: