blob: d5d91c994f1d33b45950cdf8062d978b624ad635 [file] [log] [blame]
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<body>
This package contains classes representing various <i>problems</i>
that can be encountered during compilation.
<p>
<i>Problem</i> is a generic term for an error or warning.
Each problem has a <i>default severity</i> classifying it as
<code>CompilerProblemSeverity.ERROR</code>,
<code>CompilerProblemSeverity.WARNING</code>, or
<code>CompilerProblemSeverity.IGNORE</code>.
The severity of any problem can be changed
from the default setting by compiler options.
Ignored problems are simply not reported by clients.
</p>
<p>
Every problem class has an English <code>DESCRIPTION</code> field.
This field can use named placeholders such as <code>${className}</code>;
the value of the corresponding field in the problem object is substituted
when the problem is displayed.
</p>
<p>
An English Java <code>.properties</code> file gets built from the
<code>DESCRIPTION</code> fields and then localized.
</p>
</body>
</html>