Skip to content

Commit 7bf0d14

Browse files
committed
8300133: Use generalized see and link tags in core libs
Reviewed-by: jjg, mchung, naoto, smarks
1 parent 2a46e07 commit 7bf0d14

File tree

10 files changed

+88
-107
lines changed

10 files changed

+88
-107
lines changed

src/java.base/share/classes/java/lang/CharSequence.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2000, 2023, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -73,8 +73,8 @@ public interface CharSequence {
7373
* indexing.
7474
*
7575
* <p>If the {@code char} value specified by the index is a
76-
* <a href="{@docRoot}/java.base/java/lang/Character.html#unicode">surrogate</a>, the surrogate
77-
* value is returned.
76+
* {@linkplain Character##unicode surrogate}, the surrogate value
77+
* is returned.
7878
*
7979
* @param index the index of the {@code char} value to be returned
8080
*
@@ -132,9 +132,9 @@ default boolean isEmpty() {
132132

133133
/**
134134
* Returns a stream of {@code int} zero-extending the {@code char} values
135-
* from this sequence. Any char which maps to a <a
136-
* href="{@docRoot}/java.base/java/lang/Character.html#unicode">surrogate code
137-
* point</a> is passed through uninterpreted.
135+
* from this sequence. Any char which maps to a
136+
* {@linkplain Character##unicode surrogate code point} is passed
137+
* through uninterpreted.
138138
*
139139
* <p>The stream binds to this sequence when the terminal stream operation
140140
* commences (specifically, for mutable sequences the spliterator for the

src/java.base/share/classes/java/lang/String.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -4067,9 +4067,9 @@ public String toString() {
40674067

40684068
/**
40694069
* Returns a stream of {@code int} zero-extending the {@code char} values
4070-
* from this sequence. Any char which maps to a <a
4071-
* href="{@docRoot}/java.base/java/lang/Character.html#unicode">surrogate code
4072-
* point</a> is passed through uninterpreted.
4070+
* from this sequence. Any char which maps to a {@linkplain
4071+
* Character##unicode surrogate code point} is passed through
4072+
* uninterpreted.
40734073
*
40744074
* @return an IntStream of char values from this sequence
40754075
* @since 9

src/java.base/share/classes/java/lang/module/Configuration.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2014, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2014, 2023, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -48,8 +48,8 @@
4848

4949
/**
5050
* A configuration that is the result of <a href="package-summary.html#resolution">
51-
* resolution</a> or resolution with
52-
* <a href="{@docRoot}/java.base/java/lang/module/Configuration.html#service-binding">service binding</a>.
51+
* resolution</a> or resolution with {@linkplain
52+
* Configuration##service-binding service binding}.
5353
*
5454
* <p> A configuration encapsulates the <em>readability graph</em> that is the
5555
* output of resolution. A readability graph is a directed graph whose vertices

src/java.base/share/classes/java/math/BigDecimal.java

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1996, 2022, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1996, 2023, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -3102,9 +3102,8 @@ public BigDecimal stripTrailingZeros() {
31023102
* @apiNote
31033103
* Note: this class has a natural ordering that is inconsistent with equals.
31043104
* The behavior of comparing the result of this method for
3105-
* equality to 0 is analogous to checking the <a
3106-
* href="{@docRoot}/java.base/java/lang/Double.html#fpNumericalEq">numerical
3107-
* equality</a> of {@code double} values.
3105+
* equality to 0 is analogous to checking the {@linkplain
3106+
* Double##fpNumericalEq numerical equality} of {@code double} values.
31083107
*
31093108
* @param val {@code BigDecimal} to which this {@code BigDecimal} is
31103109
* to be compared.
@@ -3197,9 +3196,9 @@ else if (ys != INFLATED)
31973196
* HALF_UP)} which evaluates to 0.7 and <br>
31983197
* {@code new BigDecimal("2.00").divide(BigDecimal.valueOf(3),
31993198
* HALF_UP)} which evaluates to 0.67.
3200-
* The behavior of this method is analogous to checking the <a
3201-
* href="{@docRoot}/java.base/java/lang/Double.html#repEquivalence">representation
3202-
* equivalence</a> of {@code double} values.
3199+
* The behavior of this method is analogous to checking the
3200+
* {@linkplain Double##repEquivalence representation equivalence}
3201+
* of {@code double} values.
32033202
*
32043203
* @param x {@code Object} to which this {@code BigDecimal} is
32053204
* to be compared.

src/java.base/share/classes/java/net/spi/InetAddressResolverProvider.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -41,8 +41,8 @@
4141
*
4242
* <p> A given invocation of the Java virtual machine maintains a single
4343
* system-wide resolver instance, which is used by
44-
* <a href="{@docRoot}/java.base/java/net/InetAddress.html#host-name-resolution">
45-
* InetAddress</a>. It is set after the VM is fully initialized and when an
44+
* {@linkplain InetAddress##host-name-resolution
45+
* InetAddress}. It is set after the VM is fully initialized and when an
4646
* invocation of a method in {@link InetAddress} class triggers the first lookup
4747
* operation.
4848
*
@@ -60,8 +60,8 @@
6060
* method. The returned {@code InetAddressResolver} will be set as the
6161
* system-wide resolver.
6262
* <li>If the previous step fails to find any resolver provider the
63-
* <a href="{@docRoot}/java.base/java/net/InetAddress.html#built-in-resolver">
64-
* built-in resolver</a> will be set as the system-wide resolver.
63+
* {@linkplain InetAddress##built-in-resolver
64+
* built-in resolver} will be set as the system-wide resolver.
6565
* </ol>
6666
*
6767
* <p> If instantiating a custom resolver from a provider discovered in

src/java.base/share/classes/java/util/Collection.java

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1997, 2023, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -280,10 +280,10 @@ public interface Collection<E> extends Iterable<E> {
280280
* element
281281
* @throws ClassCastException if the type of the specified element
282282
* is incompatible with this collection
283-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
283+
* ({@linkplain Collection##optional-restrictions optional})
284284
* @throws NullPointerException if the specified element is null and this
285285
* collection does not permit null elements
286-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
286+
* ({@linkplain Collection##optional-restrictions optional})
287287
*/
288288
boolean contains(Object o);
289289

@@ -463,10 +463,10 @@ default <T> T[] toArray(IntFunction<T[]> generator) {
463463
* @return {@code true} if an element was removed as a result of this call
464464
* @throws ClassCastException if the type of the specified element
465465
* is incompatible with this collection
466-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
466+
* ({@linkplain Collection##optional-restrictions optional})
467467
* @throws NullPointerException if the specified element is null and this
468468
* collection does not permit null elements
469-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
469+
* ({@linkplain Collection##optional-restrictions optional})
470470
* @throws UnsupportedOperationException if the {@code remove} operation
471471
* is not supported by this collection
472472
*/
@@ -485,11 +485,11 @@ default <T> T[] toArray(IntFunction<T[]> generator) {
485485
* @throws ClassCastException if the types of one or more elements
486486
* in the specified collection are incompatible with this
487487
* collection
488-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
488+
* ({@linkplain Collection##optional-restrictions optional})
489489
* @throws NullPointerException if the specified collection contains one
490490
* or more null elements and this collection does not permit null
491491
* elements
492-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>),
492+
* ({@linkplain Collection##optional-restrictions optional})
493493
* or if the specified collection is null.
494494
* @see #contains(Object)
495495
*/
@@ -535,11 +535,11 @@ default <T> T[] toArray(IntFunction<T[]> generator) {
535535
* @throws ClassCastException if the types of one or more elements
536536
* in this collection are incompatible with the specified
537537
* collection
538-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
538+
* ({@linkplain Collection##optional-restrictions optional})
539539
* @throws NullPointerException if this collection contains one or more
540540
* null elements and the specified collection does not support
541541
* null elements
542-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>),
542+
* ({@linkplain Collection##optional-restrictions optional})
543543
* or if the specified collection is null
544544
* @see #remove(Object)
545545
* @see #contains(Object)
@@ -594,11 +594,11 @@ default boolean removeIf(Predicate<? super E> filter) {
594594
* @throws ClassCastException if the types of one or more elements
595595
* in this collection are incompatible with the specified
596596
* collection
597-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
597+
* ({@linkplain Collection##optional-restrictions optional})
598598
* @throws NullPointerException if this collection contains one or more
599599
* null elements and the specified collection does not permit null
600600
* elements
601-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>),
601+
* ({@linkplain Collection##optional-restrictions optional})
602602
* or if the specified collection is null
603603
* @see #remove(Object)
604604
* @see #contains(Object)

src/java.base/share/classes/java/util/Deque.java

+8-8
Original file line numberDiff line numberDiff line change
@@ -363,10 +363,10 @@ public interface Deque<E> extends Queue<E> {
363363
* @return {@code true} if an element was removed as a result of this call
364364
* @throws ClassCastException if the class of the specified element
365365
* is incompatible with this deque
366-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
366+
* ({@linkplain Collection##optional-restrictions optional})
367367
* @throws NullPointerException if the specified element is null and this
368368
* deque does not permit null elements
369-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
369+
* ({@linkplain Collection##optional-restrictions optional})
370370
*/
371371
boolean removeFirstOccurrence(Object o);
372372

@@ -382,10 +382,10 @@ public interface Deque<E> extends Queue<E> {
382382
* @return {@code true} if an element was removed as a result of this call
383383
* @throws ClassCastException if the class of the specified element
384384
* is incompatible with this deque
385-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
385+
* ({@linkplain Collection##optional-restrictions optional})
386386
* @throws NullPointerException if the specified element is null and this
387387
* deque does not permit null elements
388-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
388+
* ({@linkplain Collection##optional-restrictions optional})
389389
*/
390390
boolean removeLastOccurrence(Object o);
391391

@@ -565,10 +565,10 @@ public interface Deque<E> extends Queue<E> {
565565
* @return {@code true} if an element was removed as a result of this call
566566
* @throws ClassCastException if the class of the specified element
567567
* is incompatible with this deque
568-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
568+
* ({@linkplain Collection##optional-restrictions optional})
569569
* @throws NullPointerException if the specified element is null and this
570570
* deque does not permit null elements
571-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
571+
* ({@linkplain Collection##optional-restrictions optional})
572572
*/
573573
boolean remove(Object o);
574574

@@ -581,10 +581,10 @@ public interface Deque<E> extends Queue<E> {
581581
* @return {@code true} if this deque contains the specified element
582582
* @throws ClassCastException if the class of the specified element
583583
* is incompatible with this deque
584-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
584+
* ({@linkplain Collection##optional-restrictions optional})
585585
* @throws NullPointerException if the specified element is null and this
586586
* deque does not permit null elements
587-
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
587+
* ({@linkplain Collection##optional-restrictions optional})
588588
*/
589589
boolean contains(Object o);
590590

0 commit comments

Comments
 (0)