JaroslavTulach commented on a change in pull request #2955: URL: https://github.com/apache/netbeans/pull/2955#discussion_r632640545
########## File path: ide/api.lsp/src/org/netbeans/spi/lsp/HoverProvider.java ########## @@ -0,0 +1,56 @@ +/* + * 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. + */ +package org.netbeans.spi.lsp; + +import java.util.concurrent.CompletableFuture; +import javax.swing.text.Document; +import org.netbeans.api.annotations.common.NonNull; +import org.netbeans.spi.editor.mimelookup.MimeLocation; + +/** + * Interface for resolving hover information at a given document position. + * Implementations of the interface should be registered in MimeLookup. + * <pre> + * + * {@code @MimeRegistration(mimeType = "text/foo", service = HoverProvider.class) Review comment: Can you please use `{@codesnippet}`? Also update other examples to use the tag? See [codesnippet4javadoc](https://github.com/jtulach/codesnippet4javadoc). ########## File path: ide/api.lsp/apichanges.xml ########## @@ -47,6 +47,21 @@ <!-- ACTUAL CHANGES BEGIN HERE: --> <changes> + <change id="HoverProvider"> + <api name="LSP_API"/> + <summary>Adding Hover and HoverProvider</summary> + <version major="1" minor="2"/> + <date day="13" month="5" year="2021"/> + <author login="dbalek"/> + <compatibility binary="compatible" source="compatible" addition="yes" deletion="no"/> + <description> + A <code>Hover</code> class and <code>HoverProvider</code> interface introduced + that allows to resolve a hover information at a given document offset and + return its content. + </description> + <class package="org.netbeans.api.lsp" name="Hover"/> + <class package="org.netbeans.spi.lsp" name="HoverProvider"/> + </change> <change id="HyperlinkTypeDefLocationProvider"> Review comment: Is there an `arch.xml` document? It has to be and it should define one `<api type="export" group="stable"/>` to make the Javadoc mention proper stability on its background. ########## File path: ide/api.lsp/apichanges.xml ########## @@ -47,6 +47,21 @@ <!-- ACTUAL CHANGES BEGIN HERE: --> <changes> + <change id="HoverProvider"> Review comment: I don't see any `api.lsp` Javadoc at https://bits.netbeans.org/dev/javadoc/ -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected] For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
