Skip to content

Commit

Permalink
Improve Javadoc formatting of o.e.core.runtime.Platform constants
Browse files Browse the repository at this point in the history
  • Loading branch information
@HannesWell
HannesWell committed Oct 2, 2024
1 parent 916d7f2 commit 44074c7
Showing 1 changed file with 55 additions and 40 deletions.
95 changes: 55 additions & 40 deletions runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/Platform.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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).
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @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.
* <p>
* Note this constant has been moved from the deprecated
Expand All @@ -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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @since 3.0
*
* @deprecated not supported anymore
Expand All @@ -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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @since 3.0
*
* @deprecated not supported anymore
Expand All @@ -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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @since 3.0
*
* @deprecated not supported anymore
Expand All @@ -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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
Expand All @@ -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.
* <p>
* Note this constant has been moved from the deprecated
Expand All @@ -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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
Expand All @@ -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
Expand All @@ -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 <code>ARCH_X86_64</code> instead. Note the values
* has been changed to be the value of the <code>ARCH_X86_64</code> constant.
* @deprecated use <code>ARCH_X86_64</code> instead. Note the values has been
* changed to be the value of the <code>ARCH_X86_64</code> 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
Expand All @@ -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
*
Expand All @@ -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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @since 3.0
*
* @deprecated not supported anymore
Expand All @@ -477,32 +487,34 @@ 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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @since 3.0
* @deprecated not supported anymore
*/
@Deprecated
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).
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
Expand All @@ -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.
* <p>
* Note this constant has been moved from the deprecated
* org.eclipse.core.boot.BootLoader class and its value has not changed.
* </p>
*
* @since 3.0
*/
public static final String WS_UNKNOWN = "unknown";//$NON-NLS-1$
Expand Down

0 comments on commit 44074c7

Please sign in to comment.