Skip to content

Commit 44074c7

Browse files
HannesWellHannesWell
committed
Improve Javadoc formatting of o.e.core.runtime.Platform constants
1 parent 916d7f2 commit 44074c7

File tree

1 file changed

+55
-40
lines changed
  • runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime

1 file changed

+55
-40
lines changed

‎runtime/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/Platform.java

Lines changed: 55 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -238,29 +238,31 @@ public static boolean isMac() {
238238
public static final int FAILED_DELETE_METADATA = 6;
239239

240240
/**
241-
* Constant string (value "win32") indicating the platform is running on a
241+
* Constant string (value {@code win32}) indicating the platform is running on a
242242
* Window 32-bit operating system (e.g., Windows 98, NT, 2000).
243243
* <p>
244244
* Note this constant has been moved from the deprecated
245245
* org.eclipse.core.boot.BootLoader class and its value has not changed.
246246
* </p>
247+
*
247248
* @since 3.0
248249
*/
249250
public static final String OS_WIN32 = "win32";//$NON-NLS-1$
250251

251252
/**
252-
* Constant string (value "linux") indicating the platform is running on a
253+
* Constant string (value {@code linux} indicating the platform is running on a
253254
* Linux-based operating system.
254255
* <p>
255256
* Note this constant has been moved from the deprecated
256257
* org.eclipse.core.boot.BootLoader class and its value has not changed.
257258
* </p>
259+
*
258260
* @since 3.0
259261
*/
260262
public static final String OS_LINUX = "linux";//$NON-NLS-1$
261263

262264
/**
263-
* Constant string (value "aix") indicating the platform is running on an
265+
* Constant string (value {@code aix} indicating the platform is running on an
264266
* AIX-based operating system.
265267
* <p>
266268
* Note this constant has been moved from the deprecated
@@ -274,12 +276,13 @@ public static boolean isMac() {
274276
public static final String OS_AIX = "aix";//$NON-NLS-1$
275277

276278
/**
277-
* Constant string (value "solaris") indicating the platform is running on a
278-
* Solaris-based operating system.
279+
* Constant string (value {@code solaris}) indicating the platform is running on
280+
* a Solaris-based operating system.
279281
* <p>
280282
* Note this constant has been moved from the deprecated
281283
* org.eclipse.core.boot.BootLoader class and its value has not changed.
282284
* </p>
285+
*
283286
* @since 3.0
284287
*
285288
* @deprecated not supported anymore
@@ -288,12 +291,13 @@ public static boolean isMac() {
288291
public static final String OS_SOLARIS = "solaris";//$NON-NLS-1$
289292

290293
/**
291-
* Constant string (value "hpux") indicating the platform is running on an
294+
* Constant string (value {@code hpux}) indicating the platform is running on an
292295
* HP/UX-based operating system.
293296
* <p>
294297
* Note this constant has been moved from the deprecated
295298
* org.eclipse.core.boot.BootLoader class and its value has not changed.
296299
* </p>
300+
*
297301
* @since 3.0
298302
*
299303
* @deprecated not supported anymore
@@ -302,12 +306,13 @@ public static boolean isMac() {
302306
public static final String OS_HPUX = "hpux";//$NON-NLS-1$
303307

304308
/**
305-
* Constant string (value "qnx") indicating the platform is running on a
309+
* Constant string (value {@code qnx}) indicating the platform is running on a
306310
* QNX-based operating system.
307311
* <p>
308312
* Note this constant has been moved from the deprecated
309313
* org.eclipse.core.boot.BootLoader class and its value has not changed.
310314
* </p>
315+
*
311316
* @since 3.0
312317
*
313318
* @deprecated not supported anymore
@@ -316,41 +321,44 @@ public static boolean isMac() {
316321
public static final String OS_QNX = "qnx";//$NON-NLS-1$
317322

318323
/**
319-
* Constant string (value "macosx") indicating the platform is running on a
320-
* Mac OS X operating system.
324+
* Constant string (value {@code macosx}) indicating the platform is running on
325+
* a Mac OS X operating system.
321326
* <p>
322327
* Note this constant has been moved from the deprecated
323328
* org.eclipse.core.boot.BootLoader class and its value has not changed.
324329
* </p>
330+
*
325331
* @since 3.0
326332
*/
327333
public static final String OS_MACOSX = "macosx";//$NON-NLS-1$
328334

329335
/**
330-
* Constant string (value "unknown") indicating the platform is running on a
331-
* machine running an unknown operating system.
336+
* Constant string (value {@code unknown}) indicating the platform is running on
337+
* a machine running an unknown operating system.
332338
* <p>
333339
* Note this constant has been moved from the deprecated
334340
* org.eclipse.core.boot.BootLoader class and its value has not changed.
335341
* </p>
342+
*
336343
* @since 3.0
337344
*/
338345
public static final String OS_UNKNOWN = "unknown";//$NON-NLS-1$
339346

340347
/**
341-
* Constant string (value "x86") indicating the platform is running on an
348+
* Constant string (value {@code x86}) indicating the platform is running on an
342349
* x86-based architecture.
343350
* <p>
344351
* Note this constant has been moved from the deprecated
345352
* org.eclipse.core.boot.BootLoader class and its value has not changed.
346353
* </p>
354+
*
347355
* @since 3.0
348356
*/
349357
public static final String ARCH_X86 = "x86";//$NON-NLS-1$
350358

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

366374
/**
367-
* Constant string (value "ppc") indicating the platform is running on an
375+
* Constant string (value {@code ppc}) indicating the platform is running on an
368376
* PowerPC-based architecture.
369377
* <p>
370378
* Note this constant has been moved from the deprecated
@@ -379,8 +387,8 @@ public static boolean isMac() {
379387
public static final String ARCH_PPC = "ppc";//$NON-NLS-1$
380388

381389
/**
382-
* Constant string (value "sparc") indicating the platform is running on an
383-
* Sparc-based architecture.
390+
* Constant string (value {@code sparc}) indicating the platform is running on
391+
* an Sparc-based architecture.
384392
* <p>
385393
* Note this constant has been moved from the deprecated
386394
* org.eclipse.core.boot.BootLoader class and its value has not changed.
@@ -394,23 +402,23 @@ public static boolean isMac() {
394402
public static final String ARCH_SPARC = "sparc";//$NON-NLS-1$
395403

396404
/**
397-
* Constant string (value "x86_64") indicating the platform is running on an
398-
* x86 64bit-based architecture.
405+
* Constant string (value {@code x86_64}) indicating the platform is running on
406+
* an x86 64bit-based architecture.
399407
*
400408
* @since 3.1
401409
*/
402410
public static final String ARCH_X86_64 = "x86_64";//$NON-NLS-1$
403411

404412
/**
405-
* Constant string (value "aarch64") indicating the platform is running on an
406-
* AARCH64bit-based architecture.
413+
* Constant string (value {@code aarch64}) indicating the platform is running on
414+
* an AARCH64bit-based architecture.
407415
*
408416
* @since 3.22
409417
*/
410418
public static final String ARCH_AARCH64 = "aarch64";//$NON-NLS-1$
411419

412420
/**
413-
* Constant string (value {@code aarch64} indicating the platform is running on
421+
* Constant string (value {@code riscv64} indicating the platform is running on
414422
* an RISC-V 64bit-based architecture.
415423
*
416424
* @since 3.32
@@ -419,18 +427,18 @@ public static boolean isMac() {
419427
public static final String ARCH_RISCV64 = "riscv64";//$NON-NLS-1$
420428

421429
/**
422-
* Constant string (value "amd64") indicating the platform is running on an
423-
* AMD64-based architecture.
430+
* Constant string (value {@code amd64}) indicating the platform is running on
431+
* an AMD64-based architecture.
424432
*
425433
* @since 3.0
426-
* @deprecated use <code>ARCH_X86_64</code> instead. Note the values
427-
* has been changed to be the value of the <code>ARCH_X86_64</code> constant.
434+
* @deprecated use <code>ARCH_X86_64</code> instead. Note the values has been
435+
* changed to be the value of the <code>ARCH_X86_64</code> constant.
428436
*/
429437
@Deprecated
430438
public static final String ARCH_AMD64 = ARCH_X86_64;
431439

432440
/**
433-
* Constant string (value "ia64") indicating the platform is running on an
441+
* Constant string (value {@code ia64}) indicating the platform is running on an
434442
* IA64-based architecture.
435443
*
436444
* @since 3.0
@@ -441,8 +449,8 @@ public static boolean isMac() {
441449
public static final String ARCH_IA64 = "ia64"; //$NON-NLS-1$
442450

443451
/**
444-
* Constant string (value "ia64_32") indicating the platform is running on an
445-
* IA64 32bit-based architecture.
452+
* Constant string (value {@code ia64_32}) indicating the platform is running on
453+
* an IA64 32bit-based architecture.
446454
*
447455
* @since 3.1
448456
*
@@ -452,23 +460,25 @@ public static boolean isMac() {
452460
public static final String ARCH_IA64_32 = "ia64_32";//$NON-NLS-1$
453461

454462
/**
455-
* Constant string (value "win32") indicating the platform is running on a
463+
* Constant string (value {@code win32}) indicating the platform is running on a
456464
* machine using the Windows windowing system.
457465
* <p>
458466
* Note this constant has been moved from the deprecated
459467
* org.eclipse.core.boot.BootLoader class and its value has not changed.
460468
* </p>
469+
*
461470
* @since 3.0
462471
*/
463472
public static final String WS_WIN32 = "win32";//$NON-NLS-1$
464473

465474
/**
466-
* Constant string (value "motif") indicating the platform is running on a
475+
* Constant string (value {@code motif}) indicating the platform is running on a
467476
* machine using the Motif windowing system.
468477
* <p>
469478
* Note this constant has been moved from the deprecated
470479
* org.eclipse.core.boot.BootLoader class and its value has not changed.
471480
* </p>
481+
*
472482
* @since 3.0
473483
*
474484
* @deprecated not supported anymore
@@ -477,32 +487,34 @@ public static boolean isMac() {
477487
public static final String WS_MOTIF = "motif";//$NON-NLS-1$
478488

479489
/**
480-
* Constant string (value "gtk") indicating the platform is running on a
490+
* Constant string (value {@code gtk}) indicating the platform is running on a
481491
* machine using the GTK windowing system.
482492
* <p>
483493
* Note this constant has been moved from the deprecated
484494
* org.eclipse.core.boot.BootLoader class and its value has not changed.
485495
* </p>
496+
*
486497
* @since 3.0
487498
*/
488499
public static final String WS_GTK = "gtk";//$NON-NLS-1$
489500

490501
/**
491-
* Constant string (value "photon") indicating the platform is running on a
492-
* machine using the Photon windowing system.
502+
* Constant string (value {@code photon}) indicating the platform is running on
503+
* a machine using the Photon windowing system.
493504
* <p>
494505
* Note this constant has been moved from the deprecated
495506
* org.eclipse.core.boot.BootLoader class and its value has not changed.
496507
* </p>
508+
*
497509
* @since 3.0
498510
* @deprecated not supported anymore
499511
*/
500512
@Deprecated
501513
public static final String WS_PHOTON = "photon";//$NON-NLS-1$
502514

503515
/**
504-
* Constant string (value "carbon") indicating the platform is running on a
505-
* machine using the Carbon windowing system (Mac OS X).
516+
* Constant string (value {@code carbon}) indicating the platform is running on
517+
* a machine using the Carbon windowing system (Mac OS X).
506518
* <p>
507519
* Note this constant has been moved from the deprecated
508520
* org.eclipse.core.boot.BootLoader class and its value has not changed.
@@ -516,26 +528,29 @@ public static boolean isMac() {
516528
public static final String WS_CARBON = "carbon";//$NON-NLS-1$
517529

518530
/**
519-
* Constant string (value "cocoa") indicating the platform is running on a
531+
* Constant string (value {@code cocoa}) indicating the platform is running on a
520532
* machine using the Cocoa windowing system (Mac OS X).
533+
*
521534
* @since 3.5
522535
*/
523536
public static final String WS_COCOA = "cocoa";//$NON-NLS-1$
524537

525538
/**
526-
* Constant string (value "wpf") indicating the platform is running on a
539+
* Constant string (value {@code wpf}) indicating the platform is running on a
527540
* machine using the WPF windowing system.
541+
*
528542
* @since 3.3
529543
*/
530544
public static final String WS_WPF = "wpf";//$NON-NLS-1$
531545

532546
/**
533-
* Constant string (value "unknown") indicating the platform is running on a
534-
* machine running an unknown windowing system.
547+
* Constant string (value {@code unknown}) indicating the platform is running on
548+
* a machine running an unknown windowing system.
535549
* <p>
536550
* Note this constant has been moved from the deprecated
537551
* org.eclipse.core.boot.BootLoader class and its value has not changed.
538552
* </p>
553+
*
539554
* @since 3.0
540555
*/
541556
public static final String WS_UNKNOWN = "unknown";//$NON-NLS-1$

0 commit comments

Comments
 (0)