Modified:
websites/production/commons/content/proper/commons-release-plugin/apidocs/help-doc.html
==============================================================================
---
websites/production/commons/content/proper/commons-release-plugin/apidocs/help-doc.html
(original)
+++
websites/production/commons/content/proper/commons-release-plugin/apidocs/help-doc.html
Sat Apr 20 14:51:39 2024
@@ -1,50 +1,32 @@
<!DOCTYPE HTML>
-<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc -->
-<title>API Help (Apache Commons Release Plugin 1.8.1 API)</title>
+<!-- Generated by javadoc (17) -->
+<title>API Help (Apache Commons Release Plugin 1.8.2 API)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<meta name="description" content="help">
+<meta name="generator" content="javadoc/HelpWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
-<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css"
title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css"
title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css"
title="Style">
<script type="text/javascript" src="script.js"></script>
-<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
-<script type="text/javascript"
src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
-<!--[if IE]>
-<script type="text/javascript"
src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
-<![endif]-->
-<script type="text/javascript" src="jquery/jquery-3.6.1.min.js"></script>
-<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
-<body>
-<script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="API Help (Apache Commons Release Plugin
1.8.1 API)";
- }
- }
- catch(err) {
- }
-//-->
-var pathtoroot = "./";
-var useModuleDirectories = true;
+<body class="help-page">
+<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
-<header role="banner">
+<div class="flex-box">
+<header role="banner" class="flex-header">
<nav role="navigation">
-<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a id="navbar.top">
-<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation
links">Skip navigation links</a></div>
-<a id="navbar.top.firstrow">
-<!-- -->
-</a>
-<ul class="navList" title="Navigation">
+<div class="top-nav" id="navbar-top">
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation
links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
@@ -52,64 +34,77 @@ loadScripts(document, 'script');</script
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
-<li class="navBarCell1Rev">Help</li>
+<li class="nav-bar-cell1-rev">Help</li>
</ul>
</div>
-<div class="subNav">
-<ul class="navList" id="allclasses_navbar_top">
-<li><a href="allclasses.html">All Classes</a></li>
-</ul>
-<ul class="navListSearch">
-<li><label for="search">SEARCH:</label>
-<input type="text" id="search" value="search" disabled="disabled">
-<input type="reset" id="reset" value="reset" disabled="disabled">
-</li>
-</ul>
+<div class="sub-nav">
<div>
-<script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
-</script>
-<noscript>
-<div>JavaScript is disabled on your browser.</div>
-</noscript>
+<ul class="sub-nav-list">
+<li>Help: </li>
+<li><a href="#help-navigation">Navigation</a> | </li>
+<li><a href="#help-pages">Pages</a></li>
+</ul>
+</div>
+<div class="nav-list-search"><label for="search-input">SEARCH:</label>
+<input type="text" id="search-input" value="search" disabled="disabled">
+<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
-<a id="skip.navbar.top">
-<!-- -->
-</a></div>
-<!-- ========= END OF TOP NAVBAR ========= -->
</div>
-<div class="navPadding"> </div>
-<script type="text/javascript"><!--
-$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
-//-->
-</script>
-</nav>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
+<div class="flex-content">
<main role="main">
-<div class="header">
-<h1 class="title">How This API Document Is Organized</h1>
-<div class="subTitle">This API (Application Programming Interface) document
has pages corresponding to the items in the navigation bar, described as
follows.</div>
+<h1 class="title">JavaDoc Help</h1>
+<ul class="help-toc">
+<li><a href="#help-navigation">Navigation</a>:
+<ul class="help-subtoc">
+<li><a href="#help-search">Search</a></li>
+</ul>
+</li>
+<li><a href="#help-pages">Kinds of Pages</a>:
+<ul class="help-subtoc">
+<li><a href="#overview">Overview</a></li>
+<li><a href="#package">Package</a></li>
+<li><a href="#class">Class or Interface</a></li>
+<li><a href="#doc-file">Other Files</a></li>
+<li><a href="#use">Use</a></li>
+<li><a href="#tree">Tree (Class Hierarchy)</a></li>
+<li><a href="#deprecated">Deprecated API</a></li>
+<li><a href="#constant-values">Constant Field Values</a></li>
+<li><a href="#all-packages">All Packages</a></li>
+<li><a href="#all-classes">All Classes and Interfaces</a></li>
+<li><a href="#index">Index</a></li>
+</ul>
+</li>
+</ul>
+<hr>
+<div class="sub-title">
+<h2 id="help-navigation">Navigation</h2>
+Starting from the <a href="index.html">Overview</a> page, you can browse the
documentation using the links in each page, and in the navigation bar at the
top of each page. The <a href="index-all.html">Index</a> and Search box allow
you to navigate to specific declarations and summary pages, including: <a
href="allpackages-index.html">All Packages</a>, <a
href="allclasses-index.html">All Classes and Interfaces</a>
+<section class="help-section" id="help-search">
+<h3>Search</h3>
+<p>You can search for definitions of modules, packages, types, fields,
methods, system properties and other terms defined in the API, using some or
all of the name, optionally using "camelCase" abbreviations. For example:</p>
+<ul class="help-section-list">
+<li><code>j.l.obj</code> will match "java.lang.Object"</li>
+<li><code>InpStr</code> will match "java.io.InputStream"</li>
+<li><code>HM.cK</code> will match "java.util.HashMap.containsKey(Object)"</li>
+</ul>
+<p>Refer to the <a
href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/javadoc-search-spec.html";>Javadoc
Search Specification</a> for a full description of search features.</p>
+</section>
</div>
-<div class="contentContainer">
-<ul class="blockList">
-<li class="blockList">
-<section>
-<h2>Overview</h2>
+<hr>
+<div class="sub-title">
+<h2 id="help-pages">Kinds of Pages</h2>
+The following sections describe the different kinds of pages in this
collection.
+<section class="help-section" id="overview">
+<h3>Overview</h3>
<p>The <a href="index.html">Overview</a> page is the front page of this API
document and provides a list of all packages with a summary for each. This
page can also contain an overall description of the set of packages.</p>
</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Package</h2>
-<p>Each package has a page that contains a list of its classes and interfaces,
with a summary for each. These pages may contain six categories:</p>
-<ul>
+<section class="help-section" id="package">
+<h3>Package</h3>
+<p>Each package has a page that contains a list of its classes and interfaces,
with a summary for each. These pages may contain the following categories:</p>
+<ul class="help-section-list">
<li>Interfaces</li>
<li>Classes</li>
<li>Enums</li>
@@ -118,12 +113,10 @@ $('.navPadding').css('padding-top', $('.
<li>Annotation Types</li>
</ul>
</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Class or Interface</h2>
-<p>Each class, interface, nested class and nested interface has its own
separate page. Each of these pages has three sections consisting of a
class/interface description, summary tables, and detailed member
descriptions:</p>
-<ul>
+<section class="help-section" id="class">
+<h3>Class or Interface</h3>
+<p>Each class, interface, nested class and nested interface has its own
separate page. Each of these pages has three sections consisting of a
declaration and description, member summary tables, and detailed member
descriptions. Entries in each of these sections are omitted if they are empty
or not applicable.</p>
+<ul class="help-section-list">
<li>Class Inheritance Diagram</li>
<li>Direct Subclasses</li>
<li>All Known Subinterfaces</li>
@@ -132,150 +125,72 @@ $('.navPadding').css('padding-top', $('.
<li>Class or Interface Description</li>
</ul>
<br>
-<ul>
+<ul class="help-section-list">
<li>Nested Class Summary</li>
+<li>Enum Constant Summary</li>
<li>Field Summary</li>
<li>Property Summary</li>
<li>Constructor Summary</li>
<li>Method Summary</li>
-</ul>
-<br>
-<ul>
-<li>Field Detail</li>
-<li>Property Detail</li>
-<li>Constructor Detail</li>
-<li>Method Detail</li>
-</ul>
-<p>Each summary entry contains the first sentence from the detailed
description for that item. The summary entries are alphabetical, while the
detailed descriptions are in the order they appear in the source code. This
preserves the logical groupings established by the programmer.</p>
-</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Annotation Type</h2>
-<p>Each annotation type has its own separate page with the following
sections:</p>
-<ul>
-<li>Annotation Type Declaration</li>
-<li>Annotation Type Description</li>
<li>Required Element Summary</li>
<li>Optional Element Summary</li>
-<li>Element Detail</li>
</ul>
+<br>
+<ul class="help-section-list">
+<li>Enum Constant Details</li>
+<li>Field Details</li>
+<li>Property Details</li>
+<li>Constructor Details</li>
+<li>Method Details</li>
+<li>Element Details</li>
+</ul>
+<p><span class="help-note">Note:</span> Annotation interfaces have required
and optional elements, but not methods. Only enum classes have enum constants.
The components of a record class are displayed as part of the declaration of
the record class. Properties are a feature of JavaFX.</p>
+<p>The summary entries are alphabetical, while the detailed descriptions are
in the order they appear in the source code. This preserves the logical
groupings established by the programmer.</p>
+</section>
+<section class="help-section" id="doc-file">
+<h3>Other Files</h3>
+<p>Packages and modules may contain pages with additional information related
to the declarations nearby.</p>
+</section>
+<section class="help-section" id="use">
+<h3>Use</h3>
+<p>Each documented package, class and interface has its own Use page. This
page describes what packages, classes, methods, constructors and fields use any
part of the given class or package. Given a class or interface A, its Use page
includes subclasses of A, fields declared as A, methods that return A, and
methods and constructors with parameters of type A. You can access this page
by first going to the package, class or interface, then clicking on the USE
link in the navigation bar.</p>
</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Enum</h2>
-<p>Each enum has its own separate page with the following sections:</p>
-<ul>
-<li>Enum Declaration</li>
-<li>Enum Description</li>
-<li>Enum Constant Summary</li>
-<li>Enum Constant Detail</li>
-</ul>
-</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Use</h2>
-<p>Each documented package, class and interface has its own Use page. This
page describes what packages, classes, methods, constructors and fields use any
part of the given class or package. Given a class or interface A, its "Use"
page includes subclasses of A, fields declared as A, methods that return A, and
methods and constructors with parameters of type A. You can access this page
by first going to the package, class or interface, then clicking on the "Use"
link in the navigation bar.</p>
-</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Tree (Class Hierarchy)</h2>
+<section class="help-section" id="tree">
+<h3>Tree (Class Hierarchy)</h3>
<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all
packages, plus a hierarchy for each package. Each hierarchy page contains a
list of classes and a list of interfaces. Classes are organized by inheritance
structure starting with <code>java.lang.Object</code>. Interfaces do not
inherit from <code>java.lang.Object</code>.</p>
-<ul>
-<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy
for all packages.</li>
-<li>When viewing a particular package, class or interface page, clicking on
"Tree" displays the hierarchy for only that package.</li>
+<ul class="help-section-list">
+<li>When viewing the Overview page, clicking on TREE displays the hierarchy
for all packages.</li>
+<li>When viewing a particular package, class or interface page, clicking on
TREE displays the hierarchy for only that package.</li>
</ul>
</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Deprecated API</h2>
-<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the
API that have been deprecated. A deprecated API is not recommended for use,
generally due to improvements, and a replacement API is usually given.
Deprecated APIs may be removed in future implementations.</p>
-</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Index</h2>
-<p>The <a href="index-all.html">Index</a> contains an alphabetic index of all
classes, interfaces, constructors, methods, and fields, as well as lists of all
packages and all classes.</p>
-</section>
-</li>
-<li class="blockList">
-<section>
-<h2>All Classes</h2>
-<p>The <a href="allclasses.html">All Classes</a> link shows all classes and
interfaces except non-static nested types.</p>
-</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Serialized Form</h2>
-<p>Each serializable or externalizable class has a description of its
serialization fields and methods. This information is of interest to
re-implementors, not to developers using the API. While there is no link in the
navigation bar, you can get to this information by going to any serialized
class and clicking "Serialized Form" in the "See also" section of the class
description.</p>
+<section class="help-section" id="deprecated">
+<h3>Deprecated API</h3>
+<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the
API that have been deprecated. A deprecated API is not recommended for use,
generally due to shortcomings, and a replacement API is usually given.
Deprecated APIs may be removed in future implementations.</p>
</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Constant Field Values</h2>
+<section class="help-section" id="constant-values">
+<h3>Constant Field Values</h3>
<p>The <a href="constant-values.html">Constant Field Values</a> page lists the
static final fields and their values.</p>
</section>
-</li>
-<li class="blockList">
-<section>
-<h2>Search</h2>
-<p>You can search for definitions of modules, packages, types, fields, methods
and other terms defined in the API, using some or all of the name. "Camel-case"
abbreviations are supported: for example, "InpStr" will find "InputStream" and
"InputStreamReader".</p>
+<section class="help-section" id="all-packages">
+<h3>All Packages</h3>
+<p>The <a href="allpackages-index.html">All Packages</a> page contains an
alphabetic index of all packages contained in the documentation.</p>
+</section>
+<section class="help-section" id="all-classes">
+<h3>All Classes and Interfaces</h3>
+<p>The <a href="allclasses-index.html">All Classes and Interfaces</a> page
contains an alphabetic index of all classes and interfaces contained in the
documentation, including annotation interfaces, enum classes, and record
classes.</p>
+</section>
+<section class="help-section" id="index">
+<h3>Index</h3>
+<p>The <a href="index-all.html">Index</a> contains an alphabetic index of all
classes, interfaces, constructors, methods, and fields in the documentation, as
well as summary pages such as <a href="allpackages-index.html">All
Packages</a>, <a href="allclasses-index.html">All Classes and
Interfaces</a>.</p>
</section>
-</li>
-</ul>
+</div>
<hr>
-<span class="emphasizedPhrase">This help file applies to API documentation
generated by the standard doclet.</span></div>
-</main>
+<span class="help-footnote">This help file applies to API documentation
generated by the standard doclet.</span></main>
<footer role="contentinfo">
-<nav role="navigation">
-<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a id="navbar.bottom">
-<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation
links">Skip navigation links</a></div>
-<a id="navbar.bottom.firstrow">
-<!-- -->
-</a>
-<ul class="navList" title="Navigation">
-<li><a href="index.html">Overview</a></li>
-<li>Package</li>
-<li>Class</li>
-<li>Use</li>
-<li><a href="overview-tree.html">Tree</a></li>
-<li><a href="deprecated-list.html">Deprecated</a></li>
-<li><a href="index-all.html">Index</a></li>
-<li class="navBarCell1Rev">Help</li>
-</ul>
+<hr>
+<p class="legal-copy"><small>Copyright © 2018–2024 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</small></p>
+</footer>
</div>
-<div class="subNav">
-<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="allclasses.html">All Classes</a></li>
-</ul>
-<div>
-<script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
-</script>
-<noscript>
-<div>JavaScript is disabled on your browser.</div>
-</noscript>
</div>
-<a id="skip.navbar.bottom">
-<!-- -->
-</a></div>
-<!-- ======== END OF BOTTOM NAVBAR ======= -->
-</nav>
-<p class="legalCopy"><small>Copyright © 2018–2023 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</small></p>
-</footer>
</body>
</html>
\ No newline at end of file
