From d9313b23ad297123239219a277d2322d5a8baa32 Mon Sep 17 00:00:00 2001
From: Daniil Ovchinnikov <daniil.ovchinnikov@jetbrains.com>
Date: Wed, 21 Dec 2016 15:17:13 +0300
Subject: [PATCH] [wizard] update javadocs (follow up IDEA-CR-16934)

---
 .../projectWizard/ModuleNameLocationComponent.java    | 11 +++++++----
 .../ide/util/projectWizard/ModuleWizardStep.java      |  6 ++++++
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/java/idea-ui/src/com/intellij/ide/projectWizard/ModuleNameLocationComponent.java b/java/idea-ui/src/com/intellij/ide/projectWizard/ModuleNameLocationComponent.java
index 0f428ae8083b..7b1103611db4 100644
--- a/java/idea-ui/src/com/intellij/ide/projectWizard/ModuleNameLocationComponent.java
+++ b/java/idea-ui/src/com/intellij/ide/projectWizard/ModuleNameLocationComponent.java
@@ -18,10 +18,7 @@ package com.intellij.ide.projectWizard;
 import com.intellij.ide.IdeBundle;
 import com.intellij.ide.highlighter.ModuleFileType;
 import com.intellij.ide.util.BrowseFilesListener;
-import com.intellij.ide.util.projectWizard.AbstractModuleBuilder;
-import com.intellij.ide.util.projectWizard.NamePathComponent;
-import com.intellij.ide.util.projectWizard.ProjectWizardUtil;
-import com.intellij.ide.util.projectWizard.WizardContext;
+import com.intellij.ide.util.projectWizard.*;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.module.ModuleManager;
 import com.intellij.openapi.options.ConfigurationException;
@@ -71,6 +68,9 @@ public class ModuleNameLocationComponent {
     return ((AbstractModuleBuilder)myWizardContext.getProjectBuilder());
   }
 
+  /**
+   * @see ModuleWizardStep#validate()
+   */
   public boolean validate() throws ConfigurationException {
     AbstractModuleBuilder builder = getModuleBuilder();
     if (builder != null && !builder.validateModuleName(getModuleName())) return false;
@@ -79,6 +79,9 @@ public class ModuleNameLocationComponent {
     return true;
   }
 
+  /**
+   * @see ModuleWizardStep#updateDataModel()
+   */
   public void updateDataModel() {
     AbstractModuleBuilder moduleBuilder = getModuleBuilder();
     if (moduleBuilder == null) return;
diff --git a/platform/lang-api/src/com/intellij/ide/util/projectWizard/ModuleWizardStep.java b/platform/lang-api/src/com/intellij/ide/util/projectWizard/ModuleWizardStep.java
index a3cbd6c70d7f..d8a622beda3e 100644
--- a/platform/lang-api/src/com/intellij/ide/util/projectWizard/ModuleWizardStep.java
+++ b/platform/lang-api/src/com/intellij/ide/util/projectWizard/ModuleWizardStep.java
@@ -45,6 +45,12 @@ public abstract class ModuleWizardStep extends StepAdapter {
     return null;
   }
 
+  /**
+   * Validates user input before {@link #updateDataModel()} is called.
+   *
+   * @return {@code true} if input is valid, {@code false} otherwise
+   * @throws ConfigurationException if input is not valid and needs user attention. Exception message will be displayed to user
+   */
   public boolean validate() throws ConfigurationException {
     return true;
   }