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()}. + *

Returns full product name with edition. Vendor prefix is not included.

+ * + *

Use only when omitting an edition may potentially cause a confusion.
+ * Example #1: include the edition in generated shortcuts, since a user may have several editions installed.
+ * Example #2: exclude the edition from "Restart ...?" confirmation, as it only hampers readability.

+ * + *

Rarely needed, consider using {@link #getFullProductName()} instead.

+ * + * @see #getFullProductName() + * @see #getEditionName() */ public String getFullProductNameWithEdition() { return myEditionName != null ? myFullProductName + ' ' + myEditionName : myFullProductName;