archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 15:24:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base

Browse source 
Minor coding style update of javadoc tag in any file in java.base

Reviewed-by: bchristi, lancea
This commit is contained in:
Julia Boes 2019-09-24 09:43:43 +01:00
parent 13d0bac294
commit d15a57b842
139 changed files with 3499 additions and 3499 deletions
Download patch file Download diff file Expand all files Collapse all files

50
src/java.base/share/classes/java/util/jar/JarEntry.java
View file

@ -42,11 +42,11 @@ class JarEntry extends ZipEntry {
CodeSigner[] signers;
/**
* Creates a new <code>JarEntry</code> for the specified JAR file
* Creates a new {@code JarEntry} for the specified JAR file
* entry name.
*
* @param name the JAR file entry name
* @throws NullPointerException if the entry name is <code>null</code>
* @throws NullPointerException if the entry name is {@code null}
* @throws IllegalArgumentException if the entry name is longer than
* 0xFFFF bytes.
*/
@ -55,20 +55,20 @@ class JarEntry extends ZipEntry {
}
/**
* Creates a new <code>JarEntry</code> with fields taken from the
* specified <code>ZipEntry</code> object.
* @param ze the <code>ZipEntry</code> object to create the
* <code>JarEntry</code> from
* Creates a new {@code JarEntry} with fields taken from the
* specified {@code ZipEntry} object.
* @param ze the {@code ZipEntry} object to create the
* {@code JarEntry} from
*/
public JarEntry(ZipEntry ze) {
super(ze);
}
/**
* Creates a new <code>JarEntry</code> with fields taken from the
* specified <code>JarEntry</code> object.
* Creates a new {@code JarEntry} with fields taken from the
* specified {@code JarEntry} object.
*
* @param je the <code>JarEntry</code> to copy
* @param je the {@code JarEntry} to copy
*/
public JarEntry(JarEntry je) {
this((ZipEntry)je);
@ -78,11 +78,11 @@ class JarEntry extends ZipEntry {
}
/**
* Returns the <code>Manifest</code> <code>Attributes</code> for this
* entry, or <code>null</code> if none.
* Returns the {@code Manifest} {@code Attributes} for this
* entry, or {@code null} if none.
*
* @return the <code>Manifest</code> <code>Attributes</code> for this
* entry, or <code>null</code> if none
* @return the {@code Manifest} {@code Attributes} for this
* entry, or {@code null} if none
* @throws IOException if an I/O error has occurred
*/
public Attributes getAttributes() throws IOException {
@ -90,11 +90,11 @@ class JarEntry extends ZipEntry {
}
/**
* Returns the <code>Certificate</code> objects for this entry, or
* <code>null</code> if none. This method can only be called once
* the <code>JarEntry</code> has been completely verified by reading
* Returns the {@code Certificate} objects for this entry, or
* {@code null} if none. This method can only be called once
* the {@code JarEntry} has been completely verified by reading
* from the entry input stream until the end of the stream has been
* reached. Otherwise, this method will return <code>null</code>.
* reached. Otherwise, this method will return {@code null}.
*
* <p>The returned certificate array comprises all the signer certificates
* that were used to verify this entry. Each signer certificate is
@ -103,25 +103,25 @@ class JarEntry extends ZipEntry {
* bottom-to-top (i.e., with the signer certificate first and the (root)
* certificate authority last).
*
* @return the <code>Certificate</code> objects for this entry, or
* <code>null</code> if none.
* @return the {@code Certificate} objects for this entry, or
* {@code null} if none.
*/
public Certificate[] getCertificates() {
return certs == null ? null : certs.clone();
}
/**
* Returns the <code>CodeSigner</code> objects for this entry, or
* <code>null</code> if none. This method can only be called once
* the <code>JarEntry</code> has been completely verified by reading
* Returns the {@code CodeSigner} objects for this entry, or
* {@code null} if none. This method can only be called once
* the {@code JarEntry} has been completely verified by reading
* from the entry input stream until the end of the stream has been
* reached. Otherwise, this method will return <code>null</code>.
* reached. Otherwise, this method will return {@code null}.
*
* <p>The returned array comprises all the code signers that have signed
* this entry.
*
* @return the <code>CodeSigner</code> objects for this entry, or
* <code>null</code> if none.
* @return the {@code CodeSigner} objects for this entry, or
* {@code null} if none.
*
* @since 1.5
*/

36
src/java.base/share/classes/java/util/jar/JarInputStream.java
View file

@ -31,10 +31,10 @@ import sun.security.util.ManifestEntryVerifier;
import jdk.internal.util.jar.JarIndex;
/**
* The <code>JarInputStream</code> class is used to read the contents of
* The {@code JarInputStream} class is used to read the contents of
* a JAR file from any input stream. It extends the class
* <code>java.util.zip.ZipInputStream</code> with support for reading
* an optional <code>Manifest</code> entry. The <code>Manifest</code>
* {@code java.util.zip.ZipInputStream} with support for reading
* an optional {@code Manifest} entry. The {@code Manifest}
* can be used to store meta-information about the JAR file and its entries.
*
* @author David Connelly
@ -52,7 +52,7 @@ class JarInputStream extends ZipInputStream {
private boolean tryManifest;
/**
* Creates a new <code>JarInputStream</code> and reads the optional
* Creates a new {@code JarInputStream} and reads the optional
* manifest. If a manifest is present, also attempts to verify
* the signatures if the JarInputStream is signed.
* @param in the actual input stream
@ -63,7 +63,7 @@ class JarInputStream extends ZipInputStream {
}
/**
* Creates a new <code>JarInputStream</code> and reads the optional
* Creates a new {@code JarInputStream} and reads the optional
* manifest. If a manifest is present and verify is true, also attempts
* to verify the signatures if the JarInputStream is signed.
*
@ -116,11 +116,11 @@ class JarInputStream extends ZipInputStream {
}
/**
* Returns the <code>Manifest</code> for this JAR file, or
* <code>null</code> if none.
* Returns the {@code Manifest} for this JAR file, or
* {@code null} if none.
*
* @return the <code>Manifest</code> for this JAR file, or
* <code>null</code> if none.
* @return the {@code Manifest} for this JAR file, or
* {@code null} if none.
*/
public Manifest getManifest() {
return man;
@ -181,21 +181,21 @@ class JarInputStream extends ZipInputStream {
/**
* Reads from the current JAR file entry into an array of bytes.
* If <code>len</code> is not zero, the method
* If {@code len} is not zero, the method
* blocks until some input is available; otherwise, no
* bytes are read and <code>0</code> is returned.
* bytes are read and {@code 0} is returned.
* If verification has been enabled, any invalid signature
* on the current entry will be reported at some point before the
* end of the entry is reached.
* @param b the buffer into which the data is read
* @param off the start offset in the destination array <code>b</code>
* @param off the start offset in the destination array {@code b}
* @param len the maximum number of bytes to read
* @return the actual number of bytes read, or -1 if the end of the
* entry is reached
* @throws NullPointerException If <code>b</code> is <code>null</code>.
* @throws IndexOutOfBoundsException If <code>off</code> is negative,
* <code>len</code> is negative, or <code>len</code> is greater than
* <code>b.length - off</code>
* @throws NullPointerException If {@code b} is {@code null}.
* @throws IndexOutOfBoundsException If {@code off} is negative,
* {@code len} is negative, or {@code len} is greater than
* {@code b.length - off}
* @throws ZipException if a ZIP file error has occurred
* @throws IOException if an I/O error has occurred
* @throws SecurityException if any of the jar file entries
@ -215,13 +215,13 @@ class JarInputStream extends ZipInputStream {
}
/**
* Creates a new <code>JarEntry</code> (<code>ZipEntry</code>) for the
* Creates a new {@code JarEntry} ({@code ZipEntry}) for the
* specified JAR file entry name. The manifest attributes of
* the specified JAR file entry name will be copied to the new
* <CODE>JarEntry</CODE>.
*
* @param name the name of the JAR/ZIP file entry
* @return the <code>JarEntry</code> object just created
* @return the {@code JarEntry} object just created
*/
protected ZipEntry createZipEntry(String name) {
JarEntry e = new JarEntry(name);

16
src/java.base/share/classes/java/util/jar/JarOutputStream.java
View file

@ -29,11 +29,11 @@ import java.util.zip.*;
import java.io.*;
/**
* The <code>JarOutputStream</code> class is used to write the contents
* The {@code JarOutputStream} class is used to write the contents
* of a JAR file to any output stream. It extends the class
* <code>java.util.zip.ZipOutputStream</code> with support
* for writing an optional <code>Manifest</code> entry. The
* <code>Manifest</code> can be used to specify meta-information about
* {@code java.util.zip.ZipOutputStream} with support
* for writing an optional {@code Manifest} entry. The
* {@code Manifest} can be used to specify meta-information about
* the JAR file and its entries.
*
* @author David Connelly
@ -46,12 +46,12 @@ class JarOutputStream extends ZipOutputStream {
private static final int JAR_MAGIC = 0xCAFE;
/**
* Creates a new <code>JarOutputStream</code> with the specified
* <code>Manifest</code>. The manifest is written as the first
* Creates a new {@code JarOutputStream} with the specified
* {@code Manifest}. The manifest is written as the first
* entry to the output stream.
*
* @param out the actual output stream
* @param man the optional <code>Manifest</code>
* @param man the optional {@code Manifest}
* @throws IOException if an I/O error has occurred
*/
public JarOutputStream(OutputStream out, Manifest man) throws IOException {
@ -66,7 +66,7 @@ class JarOutputStream extends ZipOutputStream {
}
/**
* Creates a new <code>JarOutputStream</code> with no manifest.
* Creates a new {@code JarOutputStream} with no manifest.
* @param out the actual output stream
* @throws IOException if an I/O error has occurred
*/

4
src/java.base/share/classes/java/util/jar/package-info.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -31,7 +31,7 @@
*
* <h2>Package Specification</h2>
*
* The <code>java.util.jar</code> package is based on the following
* The {@code java.util.jar} package is based on the following
* specifications:
*
* <ul>