This is an automated email from the ASF dual-hosted git repository.
schor pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
The following commit(s) were added to refs/heads/master by this push:
new 4e80a5f [UIMA-6146] remove <h1> from package.html, java 13 javadoc
complains
4e80a5f is described below
commit 4e80a5f1dc941cf6c6a0225a9a174b990890bfc4
Author: Marshall Schor <m...@schor.com>
AuthorDate: Wed Nov 6 10:57:42 2019 -0500
[UIMA-6146] remove <h1> from package.html, java 13 javadoc complains
---
.../src/main/java/org/apache/uima/cas/impl/package.html | 10 +++++-----
uimaj-core/src/main/java/org/apache/uima/cas/package.html | 10 +++++-----
.../src/main/java/org/apache/uima/impl/package.html | 2 +-
uimaj-core/src/main/java/org/apache/uima/package.html | 2 +-
.../main/java/org/apache/uima/tools/jcasgen/package.html | 15 ++++++---------
5 files changed, 18 insertions(+), 21 deletions(-)
diff --git a/uimaj-core/src/main/java/org/apache/uima/cas/impl/package.html
b/uimaj-core/src/main/java/org/apache/uima/cas/impl/package.html
index 1ebff3a..acbb8fa 100644
--- a/uimaj-core/src/main/java/org/apache/uima/cas/impl/package.html
+++ b/uimaj-core/src/main/java/org/apache/uima/cas/impl/package.html
@@ -28,12 +28,12 @@
</head>
<body>
-<h1>Implementation and Low-Level API for the CAS Interfaces.</h1>
+Implementation and Low-Level API for the CAS Interfaces.
<p>These are Internal APIs. Use these APIs at your own risk. APIs in this
package are subject to change without notice, even in minor releases. Use of
this package is not supported. If you think you have found a bug in this
package, please try to reproduce it with the officially supported APIs before
reporting it.</p>
<hr>
-<h1>Internals documentation</h1>
+<h2>Internals documentation</h2>
<p>NOTE: This documentation is plain HTML, generated from a WYSIWIG editor
"tinymce". The way to work on this: after setting up a small
web page with the tinymce (running from a local file), use the Tools - source
code to cut/paste between this file's source and that editor.</p>
-<h2>Java Cover Objects for version 3</h2>
+<h3>Java Cover Objects for version 3</h3>
<p>The Java Cover Objects are no longer cover objects; instead, these objects
<b>are</b> the Feature Structures. The Java classes for these objects are
in a hierarchy that corresponds to the UIMA type hierarchy. JCasGen
continues to serve to generate (for user, not for built-in types) particular
Java Classes for particular UIMA Types. And, as before, JCasGen'd classes
are optional. If there was not a JCasGen'd class for "MyType" (assume a
subtype of "Annotation"), [...]
<p>There is one definition of these objects per UIMA Type System.
Support for PEARs having different "customizations" of the same JCas
classname is not supported in v3.</p>
<ul>
@@ -42,7 +42,7 @@
<li>The PEAR can still define customizations for types only it defines (that
is, not used by the outer pipeline).</li>
</ul>
<p>Much of the infrastructure is kept as-is in version 3 to support backwards
compatibility.</p>
-<h3>Format of a JCas class version 3</h3>
+<h4>Format of a JCas class version 3</h4>
<p>The _Type is not used. May revisit this if users are using the
low-level access made possible by _Type.</p>
<p>There is one definition of the class per type system. Type systems
are often shared among multiple CASes. Each definition is loaded under a
specific loader for that type system. </p>
<p>(Not implemented) <span style="text-decoration: line-through;">The loader
is set up to delegate to the parent for all classes except the JCas types, and
for those, it generates them using ASM byte code generation from the fully
merged TypeSystem information and existing "customizations".</span></p>
@@ -64,7 +64,7 @@
</ul>
</li>
</ul>
-<h2>UIMA Indexes</h2>
+<h3>UIMA Indexes</h3>
<p>Indexes are defined for a pipeline, and are kept as part of the general CAS
definition.</p>
<p>Each CAS View has its own instantiation of the defined indexes (there's one
definition for all views), and as a result, a particular FS may be
added-to-indexes and indexed in some views, and not in others.</p>
<p>There are 3 kinds of indexes: Sorted, Set, and Bag. The basic object
type for an index is <code>FsIndex_singleType</code>. This has 3 subtypes, one
for each of the index types:</p>
diff --git a/uimaj-core/src/main/java/org/apache/uima/cas/package.html
b/uimaj-core/src/main/java/org/apache/uima/cas/package.html
index 0dcd29d..f967b07 100644
--- a/uimaj-core/src/main/java/org/apache/uima/cas/package.html
+++ b/uimaj-core/src/main/java/org/apache/uima/cas/package.html
@@ -22,7 +22,7 @@
<html>
<body>
<p>Common Analysis System(CAS) Interfaces</p>
-<h1>Common Analysis System (CAS) Interfaces</h1>
+<h2>Common Analysis System (CAS) Interfaces</h2>
<p>The <a href="CAS.html">CAS</a> provides</p>
<ul>
<li>a set of methods for creating Feature Structures and setting / getting
their Feature values, based on parameters referencing Types and Features.</li>
@@ -39,7 +39,7 @@
</ul>
</li>
</ul>
-<h2>Type System</h2>
+<h3>Type System</h3>
<p>The Type System is a collection of types and features of each type, where
the types are in a single type hierarchy. The type/feature information is
collected from possibly multiple annotators that make up a UIMA pipeline, and
the definitions are merged.</p>
<h2>Index Repository</h2>
<p>Indexes provide a way to access those Feature Structures which have been
indexed (added to the index, and not subsequently removed). Each CAS view has a
separate set of indexes.</p>
@@ -47,7 +47,7 @@
<li>FSIndexRepository - UIMA pipelines specify a set of index definitions to
be used; these definitions are used for all views. In addition to
user-specified indexes, there are two built-in indexes: the Annotation Index,
and a default "bag" index that is used whenever no other index is defined, to
enable retrieval of all indexed Feature Structures. When users add instances to
the indexes, they do so for the indexes in just one view. Users may choose to
index the same Feature Structure in [...]
<li>FSIndex - represents a particular index over a type and its subtypes.
There are three underlying kinds of indexes: Bag, Set, and Sorted. The Set and
Sorted include a "comparator" which defines a compare order which is also used
as the definition of "equal" for Sets.</li>
</ul>
-<h2>Built-in Feature Structure classes</h2>
+<h3>Built-in Feature Structure classes</h3>
<p>This package holds the definition for many of the built-in Feature
Structures.</p>
<p>The following classes are alternate interfaces for built-in Feature
Structures; they remain for backwards compatibility.org.apache.uima.cas</p>
<table style="height: 247px;" border="1" >
@@ -95,7 +95,7 @@
</tr>
</tbody>
</table>
-<h2>Constraints - used by filtered iterators</h2>
+<h3>Constraints - used by filtered iterators</h3>
<p>Iterators may be filtered, using constraints, specified using these
interfaces.</p>
<ul>
<li>ConstraintFactor</li>
@@ -109,7 +109,7 @@
<li>FSStringConstraint</li>
<li>FSTypeConstraint</li>
</ul>
-<h2>Exception collections</h2>
+<h3>Exception collections</h3>
<p>Many of the exceptions that UIMA may throw are collected into groups here.
These classes provide one level of indirection that permit IDE environments to
conveniently locate and work with these.</p>
<table>
<caption>exceptions</caption>
diff --git a/uimaj-core/src/main/java/org/apache/uima/impl/package.html
b/uimaj-core/src/main/java/org/apache/uima/impl/package.html
index 8fe7e0a..9f11c5f 100644
--- a/uimaj-core/src/main/java/org/apache/uima/impl/package.html
+++ b/uimaj-core/src/main/java/org/apache/uima/impl/package.html
@@ -20,7 +20,7 @@
-->
<html>
<body>
-<h1>Apache UIMA internals</h1>
+Apache UIMA internals
<p>Contains reference implementations of the interfaces in
<code>org.apache.uima</code>.</p>
</body>
</html>
diff --git a/uimaj-core/src/main/java/org/apache/uima/package.html
b/uimaj-core/src/main/java/org/apache/uima/package.html
index e3fd5ef..1e0ddc5 100644
--- a/uimaj-core/src/main/java/org/apache/uima/package.html
+++ b/uimaj-core/src/main/java/org/apache/uima/package.html
@@ -20,7 +20,7 @@
-->
<html>
<body>
-<h1>Apache UIMA</h1>
+Apache UIMA
<p>This package contains:</p>
<ul>
<li>The {@link org.apache.uima.UIMAFramework} class provides the primary
interface point for applications.</li>
diff --git
a/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/package.html
b/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/package.html
index 4224c5d..26e5c2d 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/package.html
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/package.html
@@ -21,16 +21,13 @@
<html>
<head><title>org.apache.uima.tools.jcasgen</title></head>
<body>
-<h1>JCasGen</h1>
-<p>This describes the format of the generated JCas cover classes for UIMA
v3.</p>
-<p>In V3</p>
+Describes the format of the generated JCas cover classes for UIMA Version 3.
+
+<p>In UIMA version 3</p>
<ul>
-<li>there are no xxx_Type classes</li>
-<li>As in v2, multiple type systems may be sequentially loaded into a (reset)
CAS, under one class loader</li>
-<li>Change: one consistent JCas gen'd set of classes is loaded per class loader
-<ul>
-<li>PEARs can't switch to alternate JCas gen'd versions; these must be
manually (with assistance) merged once and the merged result put in the
classpath</li>
-</ul>
+<li>There are no xxx_Type classes.</li>
+<li>As in v2, multiple type systems may be sequentially loaded into a (reset)
CAS, under one class loader.</li>
+<li>Change: one consistent JCas gen'd set of classes is loaded per class
loader.
</li>
</ul>
</body>
