[hg] main-silver: javadoc

  • From: Tomas Stupka < >
  • To: ,
  • Subject: [hg] main-silver: javadoc
  • Date: Fri, 03 May 2013 03:47:57 -0700

changeset f32e666fb543 in main-silver ((none))
details: http://hg.netbeans.org/main-silver/rev/f32e666fb543
description:
        javadoc

diffstat:

 bugtracking/src/org/netbeans/modules/bugtracking/ide/spi/IDEServices.java |  
47 ++++++++-
 1 files changed, 39 insertions(+), 8 deletions(-)

diffs (102 lines):

diff --git 
a/bugtracking/src/org/netbeans/modules/bugtracking/ide/spi/IDEServices.java 
b/bugtracking/src/org/netbeans/modules/bugtracking/ide/spi/IDEServices.java
--- 
a/bugtracking/src/org/netbeans/modules/bugtracking/ide/spi/IDEServices.java
+++ 
b/bugtracking/src/org/netbeans/modules/bugtracking/ide/spi/IDEServices.java
@@ -52,21 +52,47 @@
  */
 public interface IDEServices {
     
+    /**
+     * Determines whether the functionality to open a document for a 
resource (file)
+     * is available. <br>
+     * 
+     * @return <code>true</code> if available, otherwise <code>false</code>
+     */
     public boolean providesOpenDocument();
+    
+    /**
+     * Opens the document representing the given resource. 
+     * <b>Note</b> that the given path doesn't necessarily have to be a 
fully qualified path, but 
+     * might be in a shorter form as given by e.g. an stacktrace - 
org/netbeans/modules/bugzilla/Bugzilla.java
+
+     * @param resourcePath
+     * @param offset 
+     */
     public void openDocument(String resourcePath, int offset);
     
+    /**
+     * Determines whether the functionality to jump to a resource is 
available. 
+     * 
+     * @return <code>true</code> if available, otherwise <code>false</code>
+     */
     public boolean providesJumpTo();
     
     /**
      * 
-     * @param resourcePath
+     * Opens a search/find resource UI prefilled with the given resource. 
+     * <br>
+     * <b>Note</b> that the given resource doesn't necessarily have to be a 
be a fully qualified path, but 
+     * might be just an arbitrary string potentially identifying e.g. a java 
type.
+     * 
+     * @param resource
      * @param title 
      */
-    public void jumpTo(String resourcePath, String title);
+    public void jumpTo(String resource, String title);
 
     /**
      * Determines whether the functionality to download a plugin is available
-     * @return 
+     * 
+     * @return <code>true</code> if available, otherwise <code>false</code>
      */
     public boolean providesPluginUpdate();
     
@@ -80,6 +106,11 @@
      */
     public Plugin getPluginUpdates(String cnb, String pluginName);
 
+    /**
+     * Determines whether patch relevant functionality is available.
+     * 
+     * @return <code>true</code> if available, otherwise <code>false</code>
+     */
     public boolean providesPatchUtils();
 
     /**
@@ -112,7 +143,7 @@
     public File selectFileContext();
 
     /**
-     * Determines whether the functionality to open the Hisotry for a 
resource (file)
+     * Determines whether the functionality to open the History for a 
resource (file)
      * is available.
      * 
      * @return <code>true</code> if available, otherwise <code>false</code>
@@ -126,8 +157,8 @@
      * it's parent and positioned on the given line.
      *
      * @param resource resourcePath representing a versioned file (not a 
folder). 
-     * <b>Note</b> that the given path musn't necessarily be the full path 
-     * - e.g. org/netbeans/modules/bugzilla/Bugzilla.jav
+     * <b>Note</b> that the given path doesn't necessarily have to be the 
full path, but 
+     * might be a shorter form as given by e.g. an stacktrace - 
org/netbeans/modules/bugzilla/Bugzilla.java
      * @param lineNumber requested line number to lock on
      * @return true if parameters are valid, the file is versioned and the 
history view was opened, 
      * otherwise false.
@@ -140,13 +171,13 @@
     public interface Plugin {
         /**
          * Returns the plugins description
-         * @return 
+         * @return the plugins description
          */
         String getDescription();
         
         /**
          * Install or Update the plugin. 
-         * @return 
+         * @return <code>true</code> in case it was possible to install the 
plugin, otherwise <code>false</code> 
          */
         boolean installOrUpdate();
     }

[hg] main-silver: javadoc

Tomas Stupka 05/03/2013

Project Features

About this Project

ConnectedDeveloper was started in November 2009, is owned by tpavek, and has 66 members.
By use of this website, you agree to the NetBeans Policies and Terms of Use (revision 20131025.e7cbc9d). © 2013, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo
 
 
Close
loading
Please Confirm
Close