From 44074c73a1f9d52587680cdc4efa75338c30a0dd Mon Sep 17 00:00:00 2001 From: Hannes Wellmann Date: Wed, 2 Oct 2024 19:58:36 +0200 Subject: [PATCH] Improve Javadoc formatting of o.e.core.runtime.Platform constants --- .../org/eclipse/core/runtime/Platform.java | 95 +++++++++++-------- 1 file changed, 55 insertions(+), 40 deletions(-) diff --git a/runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/Platform.java b/runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/Platform.java index 3f793784670..c3a81b2619d 100644 --- a/runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/Platform.java +++ b/runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/Platform.java @@ -238,29 +238,31 @@ public static boolean isMac() { public static final int FAILED_DELETE_METADATA = 6; /** - * Constant string (value "win32") indicating the platform is running on a + * Constant string (value {@code win32}) indicating the platform is running on a * Window 32-bit operating system (e.g., Windows 98, NT, 2000). *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 */ public static final String OS_WIN32 = "win32";//$NON-NLS-1$ /** - * Constant string (value "linux") indicating the platform is running on a + * Constant string (value {@code linux} indicating the platform is running on a * Linux-based operating system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 */ public static final String OS_LINUX = "linux";//$NON-NLS-1$ /** - * Constant string (value "aix") indicating the platform is running on an + * Constant string (value {@code aix} indicating the platform is running on an * AIX-based operating system. *

* Note this constant has been moved from the deprecated @@ -274,12 +276,13 @@ public static boolean isMac() { public static final String OS_AIX = "aix";//$NON-NLS-1$ /** - * Constant string (value "solaris") indicating the platform is running on a - * Solaris-based operating system. + * Constant string (value {@code solaris}) indicating the platform is running on + * a Solaris-based operating system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 * * @deprecated not supported anymore @@ -288,12 +291,13 @@ public static boolean isMac() { public static final String OS_SOLARIS = "solaris";//$NON-NLS-1$ /** - * Constant string (value "hpux") indicating the platform is running on an + * Constant string (value {@code hpux}) indicating the platform is running on an * HP/UX-based operating system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 * * @deprecated not supported anymore @@ -302,12 +306,13 @@ public static boolean isMac() { public static final String OS_HPUX = "hpux";//$NON-NLS-1$ /** - * Constant string (value "qnx") indicating the platform is running on a + * Constant string (value {@code qnx}) indicating the platform is running on a * QNX-based operating system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 * * @deprecated not supported anymore @@ -316,41 +321,44 @@ public static boolean isMac() { public static final String OS_QNX = "qnx";//$NON-NLS-1$ /** - * Constant string (value "macosx") indicating the platform is running on a - * Mac OS X operating system. + * Constant string (value {@code macosx}) indicating the platform is running on + * a Mac OS X operating system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 */ public static final String OS_MACOSX = "macosx";//$NON-NLS-1$ /** - * Constant string (value "unknown") indicating the platform is running on a - * machine running an unknown operating system. + * Constant string (value {@code unknown}) indicating the platform is running on + * a machine running an unknown operating system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 */ public static final String OS_UNKNOWN = "unknown";//$NON-NLS-1$ /** - * Constant string (value "x86") indicating the platform is running on an + * Constant string (value {@code x86}) indicating the platform is running on an * x86-based architecture. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 */ public static final String ARCH_X86 = "x86";//$NON-NLS-1$ /** - * Constant string (value "PA_RISC") indicating the platform is running on an - * PA_RISC-based architecture. + * Constant string (value {@code PA_RISC}) indicating the platform is running on + * an PA_RISC-based architecture. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. @@ -364,7 +372,7 @@ public static boolean isMac() { public static final String ARCH_PA_RISC = "PA_RISC";//$NON-NLS-1$ /** - * Constant string (value "ppc") indicating the platform is running on an + * Constant string (value {@code ppc}) indicating the platform is running on an * PowerPC-based architecture. *

* Note this constant has been moved from the deprecated @@ -379,8 +387,8 @@ public static boolean isMac() { public static final String ARCH_PPC = "ppc";//$NON-NLS-1$ /** - * Constant string (value "sparc") indicating the platform is running on an - * Sparc-based architecture. + * Constant string (value {@code sparc}) indicating the platform is running on + * an Sparc-based architecture. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. @@ -394,23 +402,23 @@ public static boolean isMac() { public static final String ARCH_SPARC = "sparc";//$NON-NLS-1$ /** - * Constant string (value "x86_64") indicating the platform is running on an - * x86 64bit-based architecture. + * Constant string (value {@code x86_64}) indicating the platform is running on + * an x86 64bit-based architecture. * * @since 3.1 */ public static final String ARCH_X86_64 = "x86_64";//$NON-NLS-1$ /** - * Constant string (value "aarch64") indicating the platform is running on an - * AARCH64bit-based architecture. + * Constant string (value {@code aarch64}) indicating the platform is running on + * an AARCH64bit-based architecture. * * @since 3.22 */ public static final String ARCH_AARCH64 = "aarch64";//$NON-NLS-1$ /** - * Constant string (value {@code aarch64} indicating the platform is running on + * Constant string (value {@code riscv64} indicating the platform is running on * an RISC-V 64bit-based architecture. * * @since 3.32 @@ -419,18 +427,18 @@ public static boolean isMac() { public static final String ARCH_RISCV64 = "riscv64";//$NON-NLS-1$ /** - * Constant string (value "amd64") indicating the platform is running on an - * AMD64-based architecture. + * Constant string (value {@code amd64}) indicating the platform is running on + * an AMD64-based architecture. * * @since 3.0 - * @deprecated use ARCH_X86_64 instead. Note the values - * has been changed to be the value of the ARCH_X86_64 constant. + * @deprecated use ARCH_X86_64 instead. Note the values has been + * changed to be the value of the ARCH_X86_64 constant. */ @Deprecated public static final String ARCH_AMD64 = ARCH_X86_64; /** - * Constant string (value "ia64") indicating the platform is running on an + * Constant string (value {@code ia64}) indicating the platform is running on an * IA64-based architecture. * * @since 3.0 @@ -441,8 +449,8 @@ public static boolean isMac() { public static final String ARCH_IA64 = "ia64"; //$NON-NLS-1$ /** - * Constant string (value "ia64_32") indicating the platform is running on an - * IA64 32bit-based architecture. + * Constant string (value {@code ia64_32}) indicating the platform is running on + * an IA64 32bit-based architecture. * * @since 3.1 * @@ -452,23 +460,25 @@ public static boolean isMac() { public static final String ARCH_IA64_32 = "ia64_32";//$NON-NLS-1$ /** - * Constant string (value "win32") indicating the platform is running on a + * Constant string (value {@code win32}) indicating the platform is running on a * machine using the Windows windowing system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 */ public static final String WS_WIN32 = "win32";//$NON-NLS-1$ /** - * Constant string (value "motif") indicating the platform is running on a + * Constant string (value {@code motif}) indicating the platform is running on a * machine using the Motif windowing system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 * * @deprecated not supported anymore @@ -477,23 +487,25 @@ public static boolean isMac() { public static final String WS_MOTIF = "motif";//$NON-NLS-1$ /** - * Constant string (value "gtk") indicating the platform is running on a + * Constant string (value {@code gtk}) indicating the platform is running on a * machine using the GTK windowing system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 */ public static final String WS_GTK = "gtk";//$NON-NLS-1$ /** - * Constant string (value "photon") indicating the platform is running on a - * machine using the Photon windowing system. + * Constant string (value {@code photon}) indicating the platform is running on + * a machine using the Photon windowing system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 * @deprecated not supported anymore */ @@ -501,8 +513,8 @@ public static boolean isMac() { public static final String WS_PHOTON = "photon";//$NON-NLS-1$ /** - * Constant string (value "carbon") indicating the platform is running on a - * machine using the Carbon windowing system (Mac OS X). + * Constant string (value {@code carbon}) indicating the platform is running on + * a machine using the Carbon windowing system (Mac OS X). *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. @@ -516,26 +528,29 @@ public static boolean isMac() { public static final String WS_CARBON = "carbon";//$NON-NLS-1$ /** - * Constant string (value "cocoa") indicating the platform is running on a + * Constant string (value {@code cocoa}) indicating the platform is running on a * machine using the Cocoa windowing system (Mac OS X). + * * @since 3.5 */ public static final String WS_COCOA = "cocoa";//$NON-NLS-1$ /** - * Constant string (value "wpf") indicating the platform is running on a + * Constant string (value {@code wpf}) indicating the platform is running on a * machine using the WPF windowing system. + * * @since 3.3 */ public static final String WS_WPF = "wpf";//$NON-NLS-1$ /** - * Constant string (value "unknown") indicating the platform is running on a - * machine running an unknown windowing system. + * Constant string (value {@code unknown}) indicating the platform is running on + * a machine running an unknown windowing system. *

* Note this constant has been moved from the deprecated * org.eclipse.core.boot.BootLoader class and its value has not changed. *

+ * * @since 3.0 */ public static final String WS_UNKNOWN = "unknown";//$NON-NLS-1$