From 945932dea2fcf608dc727e5588c18b9818b5bf13 Mon Sep 17 00:00:00 2001
From: Matthew Swift <matthew.swift@forgerock.com>
Date: Wed, 03 Apr 2013 15:16:49 +0000
Subject: [PATCH] Improve Javadoc.
---
opendj3/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Rest2LDAP.java | 13 +++++++------
1 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/opendj3/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Rest2LDAP.java b/opendj3/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Rest2LDAP.java
index 2ad567f..c2837e3 100644
--- a/opendj3/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Rest2LDAP.java
+++ b/opendj3/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Rest2LDAP.java
@@ -151,7 +151,7 @@
* configuration. The caller is still required to set the connection
* factory. See the sample configuration file for a detailed description
* of its content.
- *
+ *
* @param configuration
* The JSON configuration.
* @return A reference to this builder.
@@ -216,8 +216,9 @@
/**
* Sets the policy which should be used in order to read an entry before
- * it is deleted, or after it is added or modified.
- *
+ * it is deleted, or after it is added or modified. The default read on
+ * update policy is to use {@link ReadOnUpdatePolicy#CONTROLS controls}.
+ *
* @param policy
* The policy which should be used in order to read an entry
* before it is deleted, or after it is added or modified.
@@ -231,7 +232,7 @@
/**
* Sets the schema which should be used when attribute types and
* controls.
- *
+ *
* @param schema
* The schema which should be used when attribute types and
* controls.
@@ -500,7 +501,7 @@
* {@code Throwable} is an LDAP {@code ErrorResultException} then an
* appropriate {@code ResourceException} is returned, otherwise an
* {@code InternalServerErrorException} is returned.
- *
+ *
* @param t
* The {@code Throwable} to be converted.
* @return The equivalent resource exception.
@@ -548,7 +549,7 @@
* Creates a new connection factory using the named configuration in the
* provided JSON list of factory configurations. See the sample
* configuration file for a detailed description of its content.
- *
+ *
* @param configuration
* The JSON configuration.
* @param name
--
Gitblit v1.10.0