Skip to content

Commit 92de2b2

Browse files
nizarbenallaliach
authored andcommittedJul 22, 2024
8336039: Doccheck: HTML warnings, broken links and missing files in java.base documentation
Reviewed-by: liach, djelinski
1 parent 7ddd025 commit 92de2b2

File tree

8 files changed

+19
-20
lines changed

8 files changed

+19
-20
lines changed
 

‎src/java.base/share/classes/java/lang/classfile/components/CodeStackTracker.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2022, 2024, 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
@@ -37,7 +37,7 @@
3737
* and calculating max stack size.
3838
* <p>
3939
* Sample use:
40-
* <p>
40+
*
4141
* {@snippet lang=java :
4242
* var stackTracker = CodeStackTracker.of();
4343
* codeBuilder.transforming(stackTracker, trackedBuilder -> {

‎src/java.base/share/classes/java/lang/classfile/package-info.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2022, 2024, 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
@@ -33,11 +33,11 @@
3333
* The main class for reading classfiles is {@link java.lang.classfile.ClassModel}; we
3434
* convert bytes into a {@link java.lang.classfile.ClassModel} with {@link
3535
* java.lang.classfile.ClassFile#parse(byte[])}:
36-
* <p>
36+
*
3737
* {@snippet lang=java :
3838
* ClassModel cm = ClassFile.of().parse(bytes);
3939
* }
40-
* <p>
40+
*
4141
* There are several additional overloads of {@code parse} that let you specify
4242
* various processing options.
4343
* <p>
@@ -377,7 +377,7 @@
377377
* <p>
378378
* Then we can compose {@code fooToBar} and {@code instrumentCalls} with {@link
379379
* java.lang.classfile.CodeTransform#andThen(java.lang.classfile.CodeTransform)}:
380-
* <p>
380+
*
381381
* {@snippet lang=java :
382382
* var cc = ClassFile.of();
383383
* byte[] newBytes = cc.transform(cc.parse(bytes),
@@ -443,7 +443,7 @@
443443
* or more, zero or one, exactly one), and a list of components. The elements
444444
* of a class are fields, methods, and the attributes that can appear on
445445
* classes:
446-
* <p>
446+
*
447447
* {@snippet lang="text" :
448448
* ClassElement =
449449
* FieldModel*(UtfEntry name, Utf8Entry descriptor)
@@ -468,7 +468,7 @@
468468
* | PermittedSubclassesAttribute?(List<ClassEntry> permittedSubclasses)
469469
* | DeclarationElement*
470470
* }
471-
*<p>
471+
*
472472
* where {@code DeclarationElement} are the elements that are common to all declarations
473473
* (classes, methods, fields) and so are factored out:
474474
*

‎src/java.base/share/classes/java/lang/foreign/Arena.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
* by the garbage collector. The scope of an automatic arena is an automatic scope. As
6262
* such, the regions of memory backing memory segments allocated with the automatic arena
6363
* are deallocated at some unspecified time <em>after</em> the automatic arena (and all
64-
* the segments allocated by it) becomes <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>,
64+
* the segments allocated by it) becomes {@linkplain java.lang.ref##reachability unreachable},
6565
* as shown below:
6666
* {@snippet lang = java:
6767
* MemorySegment segment = Arena.ofAuto().allocate(100, 1); // @highlight regex='ofAuto()'

‎src/java.base/share/classes/java/lang/foreign/MemorySegment.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@ public sealed interface MemorySegment permits AbstractMemorySegmentImpl {
517517
*
518518
* @apiNote When using this method to pass a segment address to some external
519519
* operation (e.g. a JNI function), clients must ensure that the segment is
520-
* kept <a href="../../../java/lang/ref/package.html#reachability">reachable</a>
520+
* kept {@linkplain java.lang.ref##reachability reachable}
521521
* for the entire duration of the operation. A failure to do so might result
522522
* in the premature deallocation of the region of memory backing the memory
523523
* segment, in case the segment has been allocated with an
@@ -785,7 +785,7 @@ public sealed interface MemorySegment permits AbstractMemorySegmentImpl {
785785
* backing region of memory is no longer available. Furthermore, if the
786786
* provided scope is the scope of an {@linkplain Arena#ofAuto() automatic arena},
787787
* the cleanup action must not prevent the scope from becoming
788-
* <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>.
788+
* {@linkplain java.lang.ref##reachability unreachable}.
789789
* A failure to do so will permanently prevent the regions of memory
790790
* allocated by the automatic arena from being deallocated.
791791
*
@@ -836,7 +836,7 @@ public sealed interface MemorySegment permits AbstractMemorySegmentImpl {
836836
* backing region of memory is no longer available. Furthermore, if the
837837
* provided scope is the scope of an {@linkplain Arena#ofAuto() automatic arena},
838838
* the cleanup action must not prevent the scope from becoming
839-
* <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>.
839+
* {@linkplain java.lang.ref##reachability unreachable}.
840840
* A failure to do so will permanently prevent the regions of memory
841841
* allocated by the automatic arena from being deallocated.
842842
*
@@ -2662,7 +2662,7 @@ static long mismatch(MemorySegment srcSegment, long srcFromOffset, long srcToOff
26622662
* invalidated, either {@link Arena#close() explicitly}, or automatically, by the
26632663
* garbage collector. A segment scope that is invalidated automatically is an
26642664
* <em>automatic scope</em>. An automatic scope is always {@link #isAlive() alive}
2665-
* as long as it is <a href="../../../java/lang/ref/package.html#reachability">reachable</a>.
2665+
* as long as it is {@linkplain java.lang.ref##reachability reachable}.
26662666
* Segments associated with an automatic scope are:
26672667
* <ul>
26682668
* <li>Segments obtained from an {@linkplain Arena#ofAuto() automatic arena};</li>

‎src/java.base/share/classes/java/lang/foreign/SymbolLookup.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ default SymbolLookup or(SymbolLookup other) {
219219
* were loaded after this method returned.
220220
* <p>
221221
* Libraries associated with a class loader are unloaded when the class loader becomes
222-
* <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>. The
222+
* {@linkplain java.lang.ref##reachability unreachable}. The
223223
* symbol lookup returned by this method is associated with an automatic
224224
* {@linkplain MemorySegment.Scope scope} which keeps the caller's class loader
225225
* reachable. Therefore, libraries associated with the caller's class loader are

‎src/java.base/share/classes/java/net/spi/InetAddressResolver.java

+2-2
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, 2024, 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
@@ -92,7 +92,7 @@ public interface InetAddressResolver {
9292
* {@linkplain InetAddressResolver#lookupByName(String, LookupPolicy) looking up host addresses}.
9393
*
9494
* <p> The default platform-wide lookup policy is constructed by consulting
95-
* <a href="doc-files/net-properties.html#Ipv4IPv6">System Properties</a> which affect
95+
* <a href="../doc-files/net-properties.html#Ipv4IPv6">System Properties</a> which affect
9696
* how IPv4 and IPv6 addresses are returned.
9797
*
9898
* @since 18

‎src/java.base/share/classes/java/text/MessageFormat.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -367,12 +367,11 @@
367367
*
368368
* <h2>Usage Information</h2>
369369
*
370-
* <p>
370+
*
371371
* The following example demonstrates a general usage of {@code MessageFormat}.
372372
* In internationalized programs, the message format pattern and other
373373
* static strings will likely be obtained from resource bundles.
374374
*
375-
* <p>
376375
* {@snippet lang=java :
377376
* int planet = 7;
378377
* String event = "a disturbance in the Force";

‎src/java.base/share/classes/javax/security/auth/Subject.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@
108108
* and {@code callAs} is similar to {@code doAs} except that the
109109
* input type and exceptions thrown are slightly different.
110110
*
111-
* <p><b><a id="sm-allowed">These methods behave differently depending on
111+
* <p id="sm-allowed"><b>These methods behave differently depending on
112112
* whether a security manager is
113-
* <a href="../../../java/lang/SecurityManager.html#set-security-manager">allowed or disallowed</a></a></b>:
113+
* {@linkplain SecurityManager##set-security-manager allowed or disallowed}</b>:
114114
* <ul>
115115
* <li>If a security manager is allowed, which means it is either already set
116116
* or allowed to be set dynamically, a {@code Subject} object is associated

0 commit comments

Comments
 (0)
Please sign in to comment.