Fix javadoc.
authorKirill Likhodedov <Kirill.Likhodedov@jetbrains.com>
Thu, 26 Jul 2012 15:18:48 +0000 (19:18 +0400)
committerKirill Likhodedov <Kirill.Likhodedov@jetbrains.com>
Thu, 26 Jul 2012 16:07:15 +0000 (20:07 +0400)
platform/vcs-api/src/com/intellij/openapi/vcs/history/DiffFromHistoryHandler.java

index 4b20ec7cb0f48fe5d49889186e99524d0abcd93c..e7edc3a16f264190a83746a7142229bf939b8a58 100644 (file)
@@ -20,7 +20,8 @@ import com.intellij.openapi.vcs.FilePath;
 import org.jetbrains.annotations.NotNull;
 
 /**
- * This handler is called when the user selects one or two revisions in the file history and invokes "Show Diff'.
+ * This handler is called when the user selects one or two revisions in the file history and invokes "Show Diff",
+ * or selected one revision and invokes "Show Diff with Local"
  * Default handler is implemented in {@code vcs-impl}.
  * Custom handlers should be returned via {@link VcsHistoryProvider#getHistoryDiffHandler()}.
  *
@@ -38,7 +39,8 @@ public interface DiffFromHistoryHandler {
   void showDiff(@NotNull AnActionEvent e, @NotNull FilePath filePath, @NotNull VcsFileRevision revision);
 
   /**
-   * Show diff for 2 revisions selected from the file history panel.
+   * Show diff for 2 revisions selected from the file history panel,
+   * or "Show Diff with Local" (then the second revision is a {@link CurrentRevision}.
    * The order of selected revisions is not defined.
    *
    * @param filePath  the file which history is shown.