You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by pa...@apache.org on 2006/12/29 17:31:01 UTC

svn commit: r491038 - in /directory/trunks/ldapstudio/ldapstudio-dsml-plugin: resources/help/ src/main/java/org/apache/directory/ldapstudio/dsmlv2/ src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/ src/main/java/org/apache/directory/ldap...

Author: pamarcelot
Date: Fri Dec 29 08:31:00 2006
New Revision: 491038

URL: http://svn.apache.org/viewvc?view=rev&rev=491038
Log:
Code & Javadoc cleaning.

Modified:
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/executing.html
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.html
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.xml
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/Activator.java
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/PreferenceInitializer.java
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/actions/ExecuteAction.java
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ConsoleDialog.java
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizard.java
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizardPage.java
    directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ImageKeys.java

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/executing.html
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/executing.html?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/executing.html (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/executing.html Fri Dec 29 08:31:00 2006
@@ -1,5 +1,22 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
 <html>
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.html
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.html?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.html (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.html Fri Dec 29 08:31:00 2006
@@ -1,5 +1,22 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
 <html>
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.xml
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.xml?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.xml (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/resources/help/toc.xml Fri Dec 29 08:31:00 2006
@@ -1,6 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?NLS TYPE="org.eclipse.help.toc"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
 
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
 <toc label="DSMLv2 Plugin Help" topic="resources/help/toc.html">
 	<topic label="Executing a DSMLv2 file"  href="resources/help/executing.html" />
 </toc>

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/Activator.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/Activator.java?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/Activator.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/Activator.java Fri Dec 29 08:31:00 2006
@@ -27,19 +27,22 @@
 
 /**
  * The activator class controls the plug-in life cycle
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
  */
 public class Activator extends AbstractUIPlugin
 {
-
-    // The plug-in ID
+    /** The plug-in ID */
     public static final String PLUGIN_ID = "org.apache.directory.ldapstudio.dsmlv2plugin"; //$NON-NLS-1$
 
-    // The shared instance
+    /** The shared instance*/
     private static Activator plugin;
 
 
     /**
-     * The constructor
+     * Creates a new instance of Activator.
+     *
      */
     public Activator()
     {
@@ -71,11 +74,11 @@
     /**
      * Returns the shared instance
      *
-     * @return the shared instance
+     * @return
+     *      the shared instance
      */
     public static Activator getDefault()
     {
         return plugin;
     }
-
 }

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/PreferenceInitializer.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/PreferenceInitializer.java?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/PreferenceInitializer.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/PreferenceInitializer.java Fri Dec 29 08:31:00 2006
@@ -29,9 +29,15 @@
 
 /**
  * This class initializes the preferences of the LDAP Studio Import/Export Plugin
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
  */
 public class PreferenceInitializer extends AbstractPreferenceInitializer
 {
+    /* (non-Javadoc)
+     * @see org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer#initializeDefaultPreferences()
+     */
     @Override
     public void initializeDefaultPreferences()
     {

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/actions/ExecuteAction.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/actions/ExecuteAction.java?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/actions/ExecuteAction.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/controller/actions/ExecuteAction.java Fri Dec 29 08:31:00 2006
@@ -33,11 +33,15 @@
 
 /**
  * This class implements the Execute Action
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
  */
 public class ExecuteAction implements IWorkbenchWindowActionDelegate
 {
-    /**
-     * This method is run when the menu item is clicked
+
+    /* (non-Javadoc)
+     * @see org.eclipse.ui.IActionDelegate#run(org.eclipse.jface.action.IAction)
      */
     public void run( IAction action )
     {
@@ -50,18 +54,27 @@
     }
 
 
+    /* (non-Javadoc)
+     * @see org.eclipse.ui.IWorkbenchWindowActionDelegate#dispose()
+     */
     public void dispose()
     {
         // This method does nothing, but is needed by the IWorkbenchWindowActionDelegate Interface
     }
 
 
+    /* (non-Javadoc)
+     * @see org.eclipse.ui.IWorkbenchWindowActionDelegate#init(org.eclipse.ui.IWorkbenchWindow)
+     */
     public void init( IWorkbenchWindow window )
     {
         // This method does nothing, but is needed by the IWorkbenchWindowActionDelegate Interface
     }
 
 
+    /* (non-Javadoc)
+     * @see org.eclipse.ui.IActionDelegate#selectionChanged(org.eclipse.jface.action.IAction, org.eclipse.jface.viewers.ISelection)
+     */
     public void selectionChanged( IAction action, ISelection selection )
     {
         // This method does nothing, but is needed by the IWorkbenchWindowActionDelegate Interface

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ConsoleDialog.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ConsoleDialog.java?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ConsoleDialog.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ConsoleDialog.java Fri Dec 29 08:31:00 2006
@@ -32,11 +32,26 @@
 import org.eclipse.swt.widgets.Text;
 
 
+/**
+ * This class implements the Console Dialog used to display the response of a DSML request
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public class ConsoleDialog extends Dialog
 {
+    /** The text to display */
     private String text;
 
 
+    /**
+     * Creates a new instance of ConsoleDialog.
+     *
+     * @param parentShell
+     *      the parent Shell
+     * @param text
+     *      the text to display
+     */
     protected ConsoleDialog( Shell parentShell, String text )
     {
         super( parentShell );

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizard.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizard.java?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizard.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizard.java Fri Dec 29 08:31:00 2006
@@ -27,11 +27,21 @@
 import org.eclipse.ui.IWorkbench;
 
 
+/**
+ * This class implements the Execute Wizard used to execute a DSML request file on a LDAP server
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public class ExecuteWizard extends Wizard implements INewWizard
 {
+    /** The wizard page*/
     ExecuteWizardPage executeWizardPage;
 
 
+    /* (non-Javadoc)
+     * @see org.eclipse.jface.wizard.Wizard#performFinish()
+     */
     @Override
     public boolean performFinish()
     {
@@ -39,21 +49,12 @@
     }
 
 
+    /* (non-Javadoc)
+     * @see org.eclipse.ui.IWorkbenchWizard#init(org.eclipse.ui.IWorkbench, org.eclipse.jface.viewers.IStructuredSelection)
+     */
     public void init( IWorkbench workbench, IStructuredSelection selection )
     {
         executeWizardPage = new ExecuteWizardPage();
         addPage( executeWizardPage );
     }
-
-
-    /* (non-Javadoc)
-     * @see org.eclipse.jface.wizard.Wizard#addPages()
-     */
-    @Override
-    public void addPages()
-    {
-        // TODO Auto-generated method stub
-        super.addPages();
-    }
-
 }

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizardPage.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizardPage.java?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizardPage.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ExecuteWizardPage.java Fri Dec 29 08:31:00 2006
@@ -51,8 +51,10 @@
 
 
 /**
- * This class implements the 
+ * This class implements the Execute Wizard Page
  *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
  */
 public class ExecuteWizardPage extends WizardPage
 {
@@ -81,7 +83,8 @@
 
 
     /**
-     * Default constructor
+     * Creates a new instance of ExecuteWizardPage.
+     *
      */
     protected ExecuteWizardPage()
     {

Modified: directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ImageKeys.java
URL: http://svn.apache.org/viewvc/directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ImageKeys.java?view=diff&rev=491038&r1=491037&r2=491038
==============================================================================
--- directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ImageKeys.java (original)
+++ directory/trunks/ldapstudio/ldapstudio-dsml-plugin/src/main/java/org/apache/directory/ldapstudio/dsmlv2/view/ImageKeys.java Fri Dec 29 08:31:00 2006
@@ -23,6 +23,9 @@
 
 /**
  * This class is used to define path for images
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
  */
 public class ImageKeys
 {