From e28d46bbf320ef3d7132c966ac42c3ef5b2c310b Mon Sep 17 00:00:00 2001
From: Roman Shevchenko <roman.shevchenko@jetbrains.com>
Date: Wed, 16 Aug 2017 15:56:12 +0200
Subject: [PATCH] Cleanup (javadoc; IDEA-CR-23794)

---
 .../openapi/application/ApplicationNamesInfo.java     | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/platform/core-api/src/com/intellij/openapi/application/ApplicationNamesInfo.java b/platform/core-api/src/com/intellij/openapi/application/ApplicationNamesInfo.java
index fd653a995dc7..de544e770d11 100644
--- a/platform/core-api/src/com/intellij/openapi/application/ApplicationNamesInfo.java
+++ b/platform/core-api/src/com/intellij/openapi/application/ApplicationNamesInfo.java
@@ -87,7 +87,16 @@ public class ApplicationNamesInfo {
   }
 
   /**
-   * Returns full product name with edition. Vendor prefix is not included. * See {@link #getFullProductName()}, {@link #getEditionName()}.
+   * <p>Returns full product name with edition. Vendor prefix is not included.</p>
+   *
+   * <p>Use only when omitting an edition may potentially cause a confusion.<br/>
+   * Example #1: include the edition in generated shortcuts, since a user may have several editions installed.<br/>
+   * Example #2: exclude the edition from "Restart ...?" confirmation, as it only hampers readability.</p>
+   *
+   * <p><strong>Rarely needed, consider using {@link #getFullProductName()} instead.</strong></p>
+   *
+   * @see #getFullProductName()
+   * @see #getEditionName()
    */
   public String getFullProductNameWithEdition() {
     return myEditionName != null ? myFullProductName + ' ' + myEditionName : myFullProductName;