Skip to content

Commit

Permalink
Enable Javadoc to be built with Java 9. (markt)
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1810300 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
markt-asf committed Oct 2, 2017
1 parent 77f1ca5 commit bf48758
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 52 deletions.
8 changes: 7 additions & 1 deletion build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,12 @@
<defaultexcludes remove="**/.gitignore" />
<!--<defaultexcludes echo="true" />-->

<!-- Java 9 -->
<available classname="java.lang.reflect.InaccessibleObjectException"
property="java9.add.modules"
value="--add-modules java.xml.ws"/>
<property name="java9.add.modules" value=""/>

<!-- Classpaths -->
<path id="compile.classpath">
<pathelement location="${jdt.jar}"/>
Expand Down Expand Up @@ -1849,7 +1855,7 @@ Apache Tomcat ${version} native binaries for Win64 AMD64/EMT64 platform.
encoding="UTF-8"
docencoding="UTF-8"
charset="UTF-8"
additionalparam="-breakiterator -notimestamp"
additionalparam="-breakiterator -notimestamp ${java9.add.modules}"
maxmemory="512m"
failonerror="true"
failonwarning="true">
Expand Down
17 changes: 9 additions & 8 deletions java/org/apache/catalina/ant/jmx/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,42 +27,43 @@
existing one. The following attribute are exists in every tasks:</p>

<table>
<caption>Common task attributes</caption>
<tr>
<th align="center" width="15%">Attribute</th>
<th align="center" width="85%">Description</th>
<th>Attribute</th>
<th>Description</th>
</tr>
<tr>
<td align="center">url</td>
<td>url</td>
<td>
The JMX Connection URL of the remote Tomcat MBeansServer.
</td>
</tr>
<tr>
<td align="center">username</td>
<td>username</td>
<td>
The username of a MBeanServer auth, when configured.
</td>
</tr>
<tr>
<td align="center">password</td>
<td>password</td>
<td>
The password of a MBeanServer auth, when configured.
</td>
</tr>
<tr>
<td align="center">host</td>
<td>host</td>
<td>
The JMX Connection host.
</td>
</tr>
<tr>
<td align="center">port</td>
<td>port</td>
<td>
The JMX Connection port.
</td>
</tr>
<tr>
<td align="center">ref</td>
<td>ref</td>
<td>
The name of the ant internal reference for a jmx connection.
</td>
Expand Down
17 changes: 9 additions & 8 deletions java/org/apache/catalina/ant/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,13 @@
</p>

<table>
<caption>Task attributes</caption>
<tr>
<th align="center" width="15%">Attribute</th>
<th align="center" width="85%">Description</th>
<th>Attribute</th>
<th>Description</th>
</tr>
<tr>
<td align="center">url</td>
<td>url</td>
<td>
The URL of the Manager web application you will use to
perform the requested operations. If not specified, defaults to
Expand All @@ -43,23 +44,23 @@
</td>
</tr>
<tr>
<td align="center">username</td>
<td>username</td>
<td>
The username of a Tomcat user that has been configured with the
<code>manager-script</code> role, as required to execute Manager
application commands. This attribute is required.
</td>
</tr>
<tr>
<td align="center">password</td>
<td>password</td>
<td>
The password of a Tomcat user that has been configured with the
<code>manager-script</code> role, as required to execute Manager
application commands. This attribute is required.
</td>
</tr>
<tr>
<td align="center">config</td>
<td>config</td>
<td>
A URL pointing at the context configuration file (i.e. a file
containing only the <code>&lt;Context&gt;</code> element, and
Expand All @@ -70,7 +71,7 @@
</td>
</tr>
<tr>
<td align="center">path</td>
<td>path</td>
<td>
The context path (including the leading slash) of the web application
this command is intended to manage, or a zero-length string for the
Expand All @@ -81,7 +82,7 @@
</td>
</tr>
<tr>
<td align="center">war</td>
<td>war</td>
<td>
A <code>jar:</code> URL that points at a web application archive (WAR)
file, or a <code>file:</code> URL that points at an unpacked directory
Expand Down
4 changes: 3 additions & 1 deletion java/org/apache/catalina/tribes/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<head>
<title>Apache Tribes - The Tomcat Cluster Communication Module</title>
</head>
<body>
<head><title>Apache Tribes - The Tomcat Cluster Communication Module</title>
<h3>QuickStart</h3>
<pre><code>
//create a channel
Expand Down
2 changes: 1 addition & 1 deletion java/org/apache/juli/logging/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ <h3>Overview</h3>
</p>

<p>This package generates commons-logging-jdk14.jar - i.e. the java.util implementation
of commons-logging api.<p>
of commons-logging api.</p>

</body>
2 changes: 0 additions & 2 deletions java/org/apache/naming/factory/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,4 @@

<p>This package contains object factories used by the naming service.</p>

<p></p>

</body>
2 changes: 0 additions & 2 deletions java/org/apache/naming/java/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,4 @@

<p>This package contains the URL context factory for the "java" namespace.</p>

<p></p>

</body>
2 changes: 0 additions & 2 deletions java/org/apache/naming/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,4 @@

<p>This package contains a memory based naming service provider.</p>

<p></p>

</body>
1 change: 0 additions & 1 deletion java/org/apache/tomcat/util/buf/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,4 @@ <H1>Buffers and Encodings</h1>
My benchmarks ( I'm costin :-) show only small differences between C2B, B2C and hand-written codders/decoders,
so UTF8Decoder may be disabled.

<p>
</body></html>
52 changes: 26 additions & 26 deletions java/org/apache/tomcat/util/digester/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
XML documents.
<br><br>
<a name="doc.Description"></a>
<div align="center">
<div>
<a href="#doc.Intro">[Introduction]</a>
<a href="#doc.Properties">[Configuration Properties]</a>
<a href="#doc.Stack">[The Object Stack]</a>
Expand Down Expand Up @@ -95,12 +95,13 @@ <h3>Digester Configuration Properties</h3>

<blockquote>
<table border="1">
<caption>Digester Configuration Properties</caption>
<tr>
<th width="15%">Property</th>
<th width="85%">Description</th>
<th>Property</th>
<th>Description</th>
</tr>
<tr>
<td align="center">classLoader</td>
<td>classLoader</td>
<td>You can optionally specify the class loader that will be used to
load classes when required by the <code>ObjectCreateRule</code>
and <code>FactoryCreateRule</code> rules. If not specified,
Expand All @@ -110,30 +111,30 @@ <h3>Digester Configuration Properties</h3>
used to load the <code>Digester</code> class itself.</td>
</tr>
<tr>
<td align="center">errorHandler</td>
<td>errorHandler</td>
<td>You can optionally specify a SAX <code>ErrorHandler</code> that
is notified when parsing errors occur. By default, any parsing
errors that are encountered are logged, but Digester will continue
processing as well.</td>
</tr>
<tr>
<td align="center">namespaceAware</td>
<td>namespaceAware</td>
<td>A boolean that is set to <code>true</code> to perform parsing in a
manner that is aware of XML namespaces. Among other things, this
setting affects how elements are matched to processing rules. See
<a href="#doc.Namespace">Namespace Aware Parsing</a> for more
information.</td>
</tr>
<tr>
<td align="center">ruleNamespaceURI</td>
<td>ruleNamespaceURI</td>
<td>The public URI of the namespace for which all subsequently added
rules are associated, or <code>null</code> for adding rules that
are not associated with any namespace. See
<a href="#doc.Namespace">Namespace Aware Parsing</a> for more
information.</td>
</tr>
<tr>
<td align="center">rules</td>
<td>rules</td>
<td>The <code>Rules</code> component that actually performs matching of
<code>Rule</code> instances against the current element nesting
pattern is pluggable. By default, Digester includes a
Expand All @@ -143,7 +144,7 @@ <h3>Digester Configuration Properties</h3>
more information.</td>
</tr>
<tr>
<td align="center">useContextClassLoader</code>
<td>useContextClassLoader</td>
<td>A boolean that is set to <code>true</code> if you want application
classes required by <code>FactoryCreateRule</code> and
<code>ObjectCreateRule</code> to be loaded from the context class
Expand All @@ -154,7 +155,7 @@ <h3>Digester Configuration Properties</h3>
will be used unconditionally.</td>
</tr>
<tr>
<td align="center">validating</td>
<td>validating</td>
<td>A boolean that is set to <code>true</code> if you wish to validate
the XML document against a Document Type Definition (DTD) that is
specified in its <code>DOCTYPE</code> declaration. The default
Expand Down Expand Up @@ -268,7 +269,7 @@ <h3>Element Matching Patterns</h3>
pattern is matched whenever an <code>&lt;a&gt;</code> top-level element is
encountered in the XML document, no matter how many times it occurs. Note that
nested <code>&lt;a&gt;</code> elements will <strong>not</strong> match this
pattern -- we will describe means to support this kind of matching later.</li>
pattern -- we will describe means to support this kind of matching later.</p>

<p>The next step up in matching pattern complexity is "a/b". This pattern will
be matched when a <code>&lt;b&gt;</code> element is found nested inside a
Expand Down Expand Up @@ -448,7 +449,7 @@ <h3>Logging</h3>
<h3>Usage Examples</h3>


<h5>Creating a Simple Object Tree</h5>
<h4>Creating a Simple Object Tree</h4>

<p>Let's assume that you have two simple JavaBeans, <code>Foo</code> and
<code>Bar</code>, with the following method signatures:</p>
Expand Down Expand Up @@ -528,7 +529,7 @@ <h5>Creating a Simple Object Tree</h5>
created for you.</p>


<h5>Processing A Struts Configuration File</h5>
<h4>Processing A Struts Configuration File</h4>

<p>As stated earlier, the primary reason that the
<code>Digester</code> package was created is because the
Expand Down Expand Up @@ -622,7 +623,7 @@ <h5>Processing A Struts Configuration File</h5>
servlet, as well as being exposed as servlet context attributes.</p>


<h5>Parsing Body Text In XML Files</h5>
<h4>Parsing Body Text In XML Files</h4>

<p>The Digester module also allows you to process the nested body text in an
XML file, not just the elements and attributes that are encountered. The
Expand Down Expand Up @@ -861,7 +862,7 @@ <h4>RegexRules</h4>
digester.setRules(new RegexRules(new SimpleRegexMatcher()));
...
</pre>
<h5>RegexMatchers</h5>
<h4>RegexMatchers</h4>
<p>
<code>Digester</code> ships only with one <code>RegexMatcher</code>
implementation: <a href='SimpleRegexMatcher.html'>SimpleRegexMatcher</a>.
Expand Down Expand Up @@ -987,7 +988,7 @@ <h3>Using Named Stacks For Inter-Rule Communication</h3>
accessed through calls to:
</p>
<ul>
<li><a href='Digester.html#push(java.lang.String, java.lang.Object)'>
<li><a href='Digester.html#push(java.lang.String,%20java.lang.Object)'>
void push(String stackName, Object value)</a></li>
<li><a href='Digester.html#pop(java.lang.String)'>
Object pop(String stackName)</a></li>
Expand Down Expand Up @@ -1063,9 +1064,9 @@ <h4>External Entity Resolution Using Digester</h4>
to be easily associated with <code><em>public-identifiers</em></code>.
</p>
<p>For example:</p>
<code><pre>
<pre>
digester.register("-//Example Dot Com //DTD Sample Example//EN", "assets/sample.dtd");
</pre></code>
</pre>
<p>
will make digester return the relative file path <code>assets/sample.dtd</code>
whenever an external entity with public id
Expand All @@ -1091,7 +1092,7 @@ <h4>Debugging Exceptions</h4>
of the XML cannot be completed. So, to diagnose the cause a certain familiarity with
the way that SAX error handling works is very useful.
</p>
<h5>Diagnosing SAX Exceptions</h5>
<h4>Diagnosing SAX Exceptions</h4>
<p>
This is a short, potted guide to SAX error handling strategies. It's not intended as a
proper guide to error handling in SAX.
Expand All @@ -1116,16 +1117,15 @@ <h5>Diagnosing SAX Exceptions</h5>
</p>
<a name="doc.FAQ"></a>
<h3>Frequently Asked Questions</h3>
<p><ul>
<ul>
<li><strong>Why do I get warnings when using a JAXP 1.1 parser?</strong>
<p>If you're using a JAXP 1.1 parser, you might see the following warning (in your log):
<code><pre>
If you're using a JAXP 1.1 parser, you might see the following warning (in your log):
<pre>
[WARN] Digester - -Error: JAXP SAXParser property not recognized: http://java.sun.com/xml/jaxp/properties/schemaLanguage
</pre></code>
</pre>
This property is needed for JAXP 1.2 (XML Schema support) as required
for the Servlet Spec. 2.4 but is not recognized by JAXP 1.1 parsers.
This warning is harmless.</p>
<p>
This warning is harmless.
</li>
<li><strong>Why Doesn't Schema Validation Work With Parser XXX Out Of The Box?</strong>
<p>
Expand Down Expand Up @@ -1160,7 +1160,7 @@ <h3>Frequently Asked Questions</h3>
</p>

<li><strong>Where Can I Find Example Code?</strong>
<a name="doc.FAQ.Examples">
<a name="doc.FAQ.Examples"></a>
<p>Digester ships with a sample application: a mapping for the <em>Rich Site
Summary</em> format used by many newsfeeds. Download the source distribution
to see how it works.</p>
Expand Down
3 changes: 3 additions & 0 deletions webapps/docs/changelog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@
<fix>
Correct Javadoc links to point to Java SE 8 and Java EE 8. (markt)
</fix>
<fix>
Enable Javadoc to be built with Java 9. (markt)
</fix>
</changelog>
</subsection>
<subsection name="Other">
Expand Down

0 comments on commit bf48758

Please sign in to comment.