Quelle  apichanges.xml   Sprache: XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- Search for CHANGEME in this document when copying and using it: -->
<!--
    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.
-->
<?xml-stylesheet type="text/xml" href="../../nbbuild/javadoctools/apichanges.xsl"?>
<!DOCTYPE apichanges PUBLIC "-//NetBeans//DTD API changes list 1.0//EN" "../../nbbuild/javadoctools/apichanges.dtd">

<!--

INFO FOR PEOPLE ADDING CHANGES:

Check the DTD (apichanges.dtd) for details on the syntax. You do not
need to regenerate the HTML, as this is part of Javadoc generation; just
change the XML. Rough syntax of a change (several parts optional):

<change>
    <api name="compiler"/>
    <summary>Some brief description here, can use <b>XHTML</b></summary>
    <version major="1" minor="99"/>
    <date day="13" month="6" year="2001"/>
    <author login="jrhacker"/>
    <compatibility addition="yes"/>
    <description>
        The main description of the change here.
        Again can use full <b>XHTML</b> as needed.
    </description>
    <class package="org.openide.compiler" name="DoWhatIWantCompiler"/>
    <issue number="14309"/>
</change>

Also permitted elements: <package>, <branch>. <version> is API spec
version, recommended for all new changes. <compatibility> should say
if things were added/modified/deprecated/etc. and give all information
related to upgrading old code. List affected top-level classes and
link to issue numbers if applicable. See the DTD for more details.

Changes need not be in any particular order, they are sorted in various
ways by the stylesheet anyway.

Dates are assumed to mean "on the trunk". If you *also* make the same
change on a stabilization branch, use the <branch> tag to indicate this
and explain why the change was made on a branch in the <description>.

Please only change this file on the trunk! Rather: you can change it
on branches if you want, but these changes will be ignored; only the
trunk version of this file is important.

Deprecations do not count as incompatible, assuming that code using the
deprecated calls continues to see their documented behavior. But do
specify deprecation="yes" in <compatibility>.

This file is not a replacement for Javadoc: it is intended to list changes,
not describe the complete current behavior, for which ordinary documentation
is the proper place.

-->

<apichanges>

    <!-- First, a list of API names you may use: -->
    <apidefs>
        <!-- org.netbeans.spi.editor.hints -->
        <apidef name="EditorHintsSPI">Editor Hints</apidef>
    </apidefs>

    <!-- ACTUAL CHANGES BEGIN HERE: -->

    <changes>

        <change id="open-settings">
             <api name="EditorHintsSPI"/>
             <summary>Added FileHintPreferences.openFilePreferences to open settings</summary>
             <version major="1" minor="57"/>
             <date day="11" month="9" year="2021"/>
             <author login="jlahoda"/>
             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 Added FileHintPreferences.openFilePreferences that opens hints settings.
             </description>
             <class name="FileHintPreferences" package="org.netbeans.spi.editor.hints.settings"/>
        </change>
        <change id="per-project-hints">
             <api name="EditorHintsSPI"/>
             <summary>Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</summary>
             <version major="1" minor="31"/>
             <date day="24" month="4" year="2013"/>
             <author login="jlahoda"/>
             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 XXX
             </description>
             <class name="FileHintPreferences" package="org.netbeans.spi.editor.hints.settings"/>
             <issue number="212326"/>
        </change>
        <change id="error-description-from-position-bounds">
             <api name="EditorHintsSPI"/>
             <summary>Added a new overload for ErrorDescriptionFactory.createErrorDescription taking PositionBounds</summary>
             <version major="1" minor="24"/>
             <date day="17" month="5" year="2012"/>
             <author login="jlahoda"/>
             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 Added several a new variant of ErrorDescriptionFactory.createErrorDescription
                 taking PositionBounds to specify the span of the error/warning.
             </description>
             <class name="ErrorDescriptionFactory" package="org.netbeans.spi.editor.hints"/>
             <issue number="212326"/>
        </change>
        <change id="id-and-details">
             <api name="EditorHintsSPI"/>
             <summary>Added id and details to ErrorDescriptionFactory.createErrorDescription</summary>
             <version major="1" minor="22"/>
             <date day="19" month="3" year="2012"/>
             <author login="jlahoda"/>
             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 Added several new variants of ErrorDescriptionFactory.createErrorDescription.
                 These new variants allow to specify an optional error/warning id and
                 more details.
             </description>
             <class name="ErrorDescriptionFactory" package="org.netbeans.spi.editor.hints"/>
             <issue number="209448"/>
        </change>
        <change id="attachSubfixes">
             <api name="EditorHintsSPI"/>
             <summary>Added ErrorDescriptionFactory.attachSubfixes</summary>
             <version major="1" minor="13"/>
             <date day="24" month="2" year="2010"/>
             <author login="jlahoda"/>
             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 Added a new method ErrorDescriptionFactory.attachSubfixes that allows
                 to attach sub-fixes to given fix.
             </description>
             <class name="ErrorDescriptionFactory" package="org.netbeans.spi.editor.hints"/>
             <issue number="180724"/>
        </change>

        <change id="Refreshers">
             <api name="EditorHintsSPI"/>
             <summary>Added PositionRefresher interface and Context</summary>
             <version major="1" minor="8" subsubminor="1"/>
             <date day="20" month="7" year="2009"/>
             <author login="msauer"/>
             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 Added new interface and context class in order to be able to provide up-to-date hints on current line.
             </description>
             <class name="PositionRefresher" package="org.netbeans.spi.editor.hints"/>
             <class name="Context" package="org.netbeans.spi.editor.hints"/>
        </change>
        
        <change id="custom-annotation-type">
             <api name="EditorHintsSPI"/>
             <summary>Added customType field and constructor to ErrorDescription</summary>
             <version major="1" minor="38" subsubminor="0"/>
             <date day="26" month="8" year="2015"/>
             <author login="danilasergeyev"/>
             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 Added customType field to ErrorDescription as well as corresponding getter method and new constructor 
                 in order to be able to provide custom annotation type for particular hint. Added new factory method to
                 ErrorDescriptionFactory which uses new ErrorDescription constructor.
             </description>
             <issue number="254375"/>
        </change>
        
        <change id="multiple-annotation-type">
             <api name="EditorHintsSPI"/>
             <summary>Support multiple ranges for ErrorDescriptor</summary>
             <version major="1" minor="42" subsubminor="0"/>
             <date day="17" month="7" year="2017"/>
             <author login="mromashova"/>
             <compatibility addition="yes" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 Added support for multiple ranges for error/warning. New field added to ErrorDescription  as well as corresponding getter method and new constructor 
                 in order to be able to provide multiple ranges support for highlight  particular hint. Added new factory method to
                 ErrorDescriptionFactory which uses new ErrorDescription constructor.
             </description>
             <issue number="271070"/>
        </change>   
        
        <change id="fixable-annotation-default-action">
             <api name="EditorHintsSPI"/>
             <summary>Provide a way to have fixable annotation with default action</summary>
             <version major="1" minor="43" subsubminor="0"/>
             <date day="24" month="7" year="2017"/>
             <author login="mromashova"/>
             <compatibility addition="no" binary="compatible" deletion="no" deprecation="no" modification="no" semantic="compatible" source="compatible"/>
             <description>
                 For custom type of annotations will dynamically register this annotation type as fixable, so Fix action (click on the icon) will work for it
             </description>
             <issue number="271069"/>
        </change>                    

    </changes>

    <!-- Now the surrounding HTML text and document structure: -->

    <htmlcontents>
<!-- Generated from apichanges.xml -->
    <head>
      <title>Change History for the Editor Hints SPI</title>
      <link rel="stylesheet" href="prose.css" type="text/css"/>
    </head>
    <body>

<p class="overviewlink"><a href="@TOP@/overview-summary.html">Overview</a></p>

<h1>Introduction</h1>

<p>This document lists changes made to the <a href="@TOP@/overview-summary.html">Editor Hints SPI</a>.</p>

<!-- The actual lists of changes, as summaries and details: -->
      <hr/>
      <standard-changelists module-code-name="org.netbeans.spi.editor.hints/0"/>

      <hr/><p>@FOOTER@</p>

    </body>
  </htmlcontents>

</apichanges>