directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From seelm...@apache.org
Subject svn commit: r494254 - in /directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions: LocateDnInDitAction.java LocateEntryInDitAction.java LocateInDitAction.java
Date Mon, 08 Jan 2007 23:31:09 GMT
Author: seelmann
Date: Mon Jan  8 15:31:08 2007
New Revision: 494254

URL: http://svn.apache.org/viewvc?view=rev&rev=494254
Log:
Added Javadocs

Modified:
    directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java
    directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java
    directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java

Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java?view=diff&rev=494254&r1=494253&r2=494254
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java
(original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateDnInDitAction.java
Mon Jan  8 15:31:08 2007
@@ -32,7 +32,11 @@
 
 
 /**
- * TODO DOCUMENT ME! LocateDnInDitAction.
+ * This action is used within the entry editor and search result editor 
+ * to locate and open the entry identified by the DN under the cursor. 
+ * 
+ * Example: Attribute "seeAlso" with value "ou=test" is selected in entry edtor. 
+ * Then this action is enabled and opens entry "ou=test" in DIT. 
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$, $Date$
@@ -66,7 +70,8 @@
 
 
     /**
-     * {@inheritDoc}
+     * This implementation returns a connection and DN if the selected attribute or value
+     * contains a valid DN.
      */
     protected Object[] getConnectionAndDn()
     {

Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java?view=diff&rev=494254&r1=494253&r2=494254
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java
(original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateEntryInDitAction.java
Mon Jan  8 15:31:08 2007
@@ -27,7 +27,8 @@
 
 
 /**
- * TODO DOCUMENT ME! LocateEntryInDitAction.
+ * This action is used within the browser view to locate and open the selected 
+ * search result or bookmark in DIT.
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$, $Date$
@@ -90,7 +91,8 @@
 
 
     /**
-     * {@inheritDoc}
+     * This implementation returns a connection and DN if the a search result or bookmark
+     * is selected.
      */
     protected Object[] getConnectionAndDn()
     {

Modified: directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java?view=diff&rev=494254&r1=494253&r2=494254
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java
(original)
+++ directory/trunks/ldapstudio/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/actions/LocateInDitAction.java
Mon Jan  8 15:31:08 2007
@@ -35,7 +35,7 @@
 
 
 /**
- * TODO DOCUMENT ME! LocateInDitAction.
+ * This action is used to locate and open an entry by its DN in DIT.
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$, $Date$
@@ -106,9 +106,11 @@
 
 
     /**
-     * TODO DOCUMENT ME! getConnectionAndDn.
-     *
-     * @return
+     * Get the connection and DN to open. It must be an array of size 2.
+     * The first element must be the IConnection object. The second
+     * element must be the DN.
+     * 
+     * @return an array with the connection and DN to open, or null.
      */
     protected abstract Object[] getConnectionAndDn();
 



Mime
View raw message