From d4fe4083382c26465b23a00875d72dacae8065c3 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Thu, 01 Oct 2015 07:58:04 +0000
Subject: [PATCH] OPENDJ-2277 Align doc with changes due to updated components
---
opendj-core/src/main/javadoc/overview.html | 36 ++++++++++++-----
opendj-core/pom.xml | 59 +++++++++++++++++++++++++++++
2 files changed, 84 insertions(+), 11 deletions(-)
diff --git a/opendj-core/pom.xml b/opendj-core/pom.xml
index 8449f41..c755ab2 100644
--- a/opendj-core/pom.xml
+++ b/opendj-core/pom.xml
@@ -182,6 +182,65 @@
</plugins>
</reporting>
</profile>
+
+ <!--
+ Generates consolidated Javadoc covering both LDAP SDK packages
+ and also dependency (and transitive dependency) ForgeRock packages.
+ -->
+ <profile>
+ <id>forgerock-release</id>
+
+ <properties>
+ <javadocTitle>OpenDJ LDAP SDK ${project.version} API</javadocTitle>
+ <timestamp>${maven.build.timestamp}</timestamp>
+ <maven.build.timestamp.format>yyyy</maven.build.timestamp.format>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>javadoc-jar</id>
+ <phase>package</phase>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <includeDependencySources>true</includeDependencySources>
+ <includeTransitiveDependencySources>true</includeTransitiveDependencySources>
+ <dependencySourceIncludes>
+ <dependencySourceInclude>org.forgerock.*:*</dependencySourceInclude>
+ </dependencySourceIncludes>
+ <excludePackageNames>com.*:*.internal</excludePackageNames>
+ <groups>
+ <group>
+ <title>${project.name} Packages</title>
+ <packages>${project.groupId}*</packages>
+ </group>
+ <group>
+ <title>ForgeRock Common Packages</title>
+ <packages>*</packages>
+ </group>
+ </groups>
+ <author>false</author>
+ <doctitle>${javadocTitle}</doctitle>
+ <windowtitle>${javadocTitle}</windowtitle>
+ <header>${javadocTitle}</header>
+ <footer>${javadocTitle}</footer>
+ <bottom>Copyright 2011-${maven.build.timestamp} ForgeRock AS.</bottom>
+ <links>
+ <link>http://docs.oracle.com/javase/7/docs/api/</link>
+ <link>http://www.slf4j.org/apidocs/</link>
+ </links>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
</profiles>
<reporting>
diff --git a/opendj-core/src/main/javadoc/overview.html b/opendj-core/src/main/javadoc/overview.html
index 69b8d30..4ecc263 100644
--- a/opendj-core/src/main/javadoc/overview.html
+++ b/opendj-core/src/main/javadoc/overview.html
@@ -1,4 +1,29 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--
+ ! CDDL HEADER START
+ !
+ ! The contents of this file are subject to the terms of the
+ ! Common Development and Distribution License, Version 1.0 only
+ ! (the "License"). You may not use this file except in compliance
+ ! with the License.
+ !
+ ! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
+ ! or http://forgerock.org/license/CDDLv1.0.html.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! When distributing Covered Code, include this CDDL HEADER in each
+ ! file and include the License file at legal-notices/CDDLv1_0.txt.
+ ! If applicable, add the following below this CDDL HEADER, with the
+ ! fields enclosed by brackets "[]" replaced with your own identifying
+ ! information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CDDL HEADER END
+ !
+ ! Copyright 2011-2015 ForgeRock AS.
+ !
+ -->
<html>
<body>
The OpenDJ SDK for Java provides a high performance easy to use
@@ -6,13 +31,6 @@
LDAP Directory Services as defined in <a
href="http://tools.ietf.org/html/rfc4510">RFC 4510</a>.
<br>
- For an introduction to LDAP, read the <em>OpenDJ SDK Developer's Guide</em>
- chapter on <a
- href="http://opendj.forgerock.org/doc/dev-guide/index.html#chap-understanding-ldap"
- >Understanding LDAP</a>. Also see the chapter on <a
- href="http://opendj.forgerock.org/doc/dev-guide/index.html#chap-best-practices"
- >Best Practices For LDAP Application Developers</a>.
- <br>
<h1>Getting Started</h1>
The following example shows how the OpenDJ SDK may be used to
connect to a directory server, authenticate, and then perform a
@@ -70,10 +88,6 @@
</tr>
</tbody>
</table>
- <br><!-- It seems the .zip is not packaged with the SDK. -->
- Additional examples can be found online at the <a
- href="http://opendj.forgerock.org/opendj-ldap-sdk-examples/"
- >OpenDJ LDAP SDK Examples</a> site.
<br>
<h1>Creating Connections</h1>
The following classes can be used to create and manage connections to
--
Gitblit v1.10.0