This is an automated email from the ASF dual-hosted git repository.
skygo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/netbeans.git
The following commit(s) were added to refs/heads/master by this push:
new 7b8f57302f apidoc fixes
new cef11a8c61 Merge pull request #5623 from ebarboni/apidocsanitize3
7b8f57302f is described below
commit 7b8f57302fd6a9ac31e0b4352d369019ea587578
Author: Eric Barboni <[email protected]>
AuthorDate: Tue Mar 7 17:28:58 2023 +0100
apidoc fixes
---
.../org/netbeans/api/java/classpath/ClassPath.java | 8 ++--
.../api/java/classpath/GlobalPathRegistry.java | 6 +--
.../org/netbeans/api/java/classpath/package.html | 2 +-
.../spi/java/classpath/ClassPathProvider.java | 4 +-
.../classpath/FlaggedClassPathImplementation.java | 4 +-
.../java/classpath/support/ClassPathSupport.java | 1 -
.../BinaryForSourceQueryImplementation.java | 9 ++--
.../BinaryForSourceQueryImplementation2.java | 8 ++--
.../SourceForBinaryQueryImplementation.java | 7 ++-
.../support/SourceForBinaryQueryImpl2Base.java | 12 +++---
ide/api.lsp/apichanges.xml | 6 +--
.../org/netbeans/api/lsp/CallHierarchyEntry.java | 4 +-
.../src/org/netbeans/api/lsp/CodeAction.java | 2 +-
.../src/org/netbeans/api/lsp/Diagnostic.java | 4 +-
.../netbeans/spi/lsp/CallHierarchyProvider.java | 8 ++--
.../org/netbeans/spi/lsp/CompletionCollector.java | 2 +-
.../src/org/netbeans/spi/lsp/ErrorProvider.java | 3 +-
.../api/xml/parsers/DocumentInputSource.java | 2 +-
ide/editor.util/apichanges.xml | 2 +-
.../lib/editor/util/AbstractCharSequence.java | 4 +-
.../netbeans/lib/editor/util/ArrayUtilities.java | 2 +-
.../lib/editor/util/CharSequenceUtilities.java | 8 ++--
.../org/netbeans/lib/editor/util/CompactMap.java | 34 +++++++--------
.../netbeans/lib/editor/util/FlyOffsetGapList.java | 10 ++---
.../org/netbeans/lib/editor/util/ListenerList.java | 3 +-
.../netbeans/lib/editor/util/OffsetGapList.java | 6 +--
.../lib/editor/util/swing/BlockCompare.java | 20 ++++-----
.../util/swing/DocumentListenerPriority.java | 2 +-
.../lib/editor/util/swing/DocumentUtilities.java | 22 +++++-----
.../editor/util/swing/MutablePositionRegion.java | 8 ++--
.../lib/editor/util/swing/PositionRegion.java | 4 +-
platform/api.templates/arch.xml | 15 ++++---
.../api/templates/CreateFromTemplateDecorator.java | 4 +-
.../api/templates/TemplateRegistration.java | 2 +-
platform/editor.mimelookup/arch.xml | 2 +-
.../netbeans/api/editor/mimelookup/MimeLookup.java | 2 +-
.../netbeans/api/editor/mimelookup/MimePath.java | 26 +++++------
.../spi/editor/mimelookup/Class2LayerFolder.java | 4 +-
.../spi/editor/mimelookup/InstanceProvider.java | 8 ++--
.../editor/mimelookup/MimeLookupInitializer.java | 4 +-
.../openide/filesystems/AbstractFileSystem.java | 2 +-
.../org/openide/filesystems/DefaultAttributes.java | 6 ++-
.../src/org/openide/filesystems/FileEvent.java | 2 +-
.../src/org/openide/filesystems/FileExtrasLkp.java | 2 +-
.../src/org/openide/filesystems/FileLock.java | 2 +-
.../src/org/openide/filesystems/FileObject.java | 13 +++---
.../src/org/openide/filesystems/FileSystem.java | 4 +-
.../src/org/openide/filesystems/FileUtil.java | 18 ++++----
.../src/org/openide/filesystems/MIMEResolver.java | 12 +++---
.../org/openide/filesystems/MultiFileSystem.java | 5 +--
.../src/org/openide/filesystems/Repository.java | 17 ++++----
.../org/openide/filesystems/StatusDecorator.java | 12 +++---
.../src/org/openide/filesystems/URLMapper.java | 2 +-
.../src/org/openide/filesystems/XMLFileSystem.java | 4 +-
.../filesystems/annotations/package-info.java | 32 +++++++-------
.../openide/filesystems/doc-files/HOWTO-MIME.html | 4 +-
.../filesystems/spi/ArchiveRootProvider.java | 8 ++--
.../filesystems/spi/CustomInstanceFactory.java | 4 +-
platform/openide.util.ui/arch.xml | 10 ++---
.../src/org/openide/ErrorManager.java | 5 +--
.../src/org/openide/util/ImageUtilities.java | 8 ++--
.../src/org/openide/util/Utilities.java | 50 +++++++++++-----------
.../src/org/openide/util/VectorIcon.java | 2 +-
.../org/openide/util/datatransfer/ExClipboard.java | 8 ++--
.../netbeans/api/fileinfo/NonRecursiveFolder.java | 4 +-
.../org/netbeans/api/queries/FileBuiltQuery.java | 4 +-
.../spi/queries/FileBuiltQueryImplementation.java | 6 +--
.../queries/SharabilityQueryImplementation.java | 4 +-
.../queries/SharabilityQueryImplementation2.java | 4 +-
69 files changed, 268 insertions(+), 270 deletions(-)
diff --git
a/ide/api.java.classpath/src/org/netbeans/api/java/classpath/ClassPath.java
b/ide/api.java.classpath/src/org/netbeans/api/java/classpath/ClassPath.java
index 9842730eb1..53bc567696 100644
--- a/ide/api.java.classpath/src/org/netbeans/api/java/classpath/ClassPath.java
+++ b/ide/api.java.classpath/src/org/netbeans/api/java/classpath/ClassPath.java
@@ -72,7 +72,7 @@ import org.openide.util.WeakListeners;
/**
* ClassPath objects should be used to access contents of the ClassPath,
searching
* for resources, objects reachable using the ClassPath at runtime. It is
intended
- * to replace some of the functionality of
<link>org.openide.filesystems.Repository</link>.
+ * to replace some of the functionality of {@link
org.openide.filesystems.Repository}.
* <BR>
* ClassPath instances should be used to map from Java-style resource names
* to FileObject (NetBeans-style resource) and vice versa. It should be also
used
@@ -601,7 +601,7 @@ public final class ClassPath {
}
/**
- * Removes the listener registered by {@link addPropertyChangeListener}.
+ * Removes the listener registered by {@link
#addPropertyChangeListener(java.beans.PropertyChangeListener) }.
* @param l a listener to remove
*/
public final void removePropertyChangeListener(PropertyChangeListener l) {
@@ -747,7 +747,7 @@ public final class ClassPath {
public enum Flag {
/**
* The incomplete {@link ClassPath} is ignored by language features
- * unless it's resolved and the {@link INCOMPLETE} flag is removed.
+ * unless it's resolved and the {@link #INCOMPLETE} flag is removed.
*/
INCOMPLETE
}
@@ -1009,7 +1009,7 @@ public final class ClassPath {
/**
* Check whether a file is included in this entry.
- * @param resource a path relative to @{link #getURL} (must be
terminated with <samp>/</samp> if a non-root folder)
+ * @param resource a path relative to @{link #getURL} (must be
terminated with <em>/</em> if a non-root folder)
* @return true if it is {@link
FilteringPathResourceImplementation#includes included}
* @since org.netbeans.api.java/1 1.13
*/
diff --git
a/ide/api.java.classpath/src/org/netbeans/api/java/classpath/GlobalPathRegistry.java
b/ide/api.java.classpath/src/org/netbeans/api/java/classpath/GlobalPathRegistry.java
index 1c960fb189..81840a57c5 100644
---
a/ide/api.java.classpath/src/org/netbeans/api/java/classpath/GlobalPathRegistry.java
+++
b/ide/api.java.classpath/src/org/netbeans/api/java/classpath/GlobalPathRegistry.java
@@ -72,7 +72,7 @@ import org.openide.util.Parameters;
* </p>
* <ol>
* <li><p>When a project is opened using
- * {@link org.netbeans.spi.project.ui.ProjectOpenedHook} it should add any
paths
+ * <a
href="@org-netbeans-modules-projectuiapi-base@/org/netbeans/spi/project/ui/ProjectOpenedHook.html">ProjectOpenedHook</a>
it should add any paths
* it defines, i.e. paths it might return from a
* {@link org.netbeans.spi.java.classpath.ClassPathProvider}.
* When closed it should remove them.</p></li>
@@ -82,7 +82,7 @@ import org.openide.util.Parameters;
* <li><p>The <b>Javadoc Index Search</b> feature and
<b>View →
* Documentation Indices</b> submenu should operate on open Javadoc paths,
* meaning that Javadoc corresponding to registered compile and boot classpaths
- * (according to {@link
org.netbeans.api.java.queries.JavadocForBinaryQuery}).</p></li>
+ * (according to <a
href="@org-netbeans-api-java@/org/netbeans/api/java/queries/JavadocForBinaryQuery.html">JavadocForBinaryQuery</a>).</p></li>
* <li><p>Stack trace hyperlinking can use the global list of source paths
* to find sources, in case no more specific information about their origin is
* available. The same would be true of debugging: if the debugger cannot find
@@ -353,7 +353,7 @@ public final class GlobalPathRegistry {
* In case more than one source root contains the resource, one is chosen
* arbitrarily.
* As with {@link ClassPath#findResource}, include/exclude lists can
affect the result.
- * @param resource a resource path, e.g. <samp>somepkg/Foo.java</samp>
+ * @param resource a resource path, e.g. <code>somepkg/Foo.java</code>
* @return some file found with that path, or null
*/
public FileObject findResource(String resource) {
diff --git
a/ide/api.java.classpath/src/org/netbeans/api/java/classpath/package.html
b/ide/api.java.classpath/src/org/netbeans/api/java/classpath/package.html
index 9b4642e6c3..b686b54575 100644
--- a/ide/api.java.classpath/src/org/netbeans/api/java/classpath/package.html
+++ b/ide/api.java.classpath/src/org/netbeans/api/java/classpath/package.html
@@ -192,7 +192,7 @@ dependencies, you may do:
<a href="ClassPath.html"><font class="type">ClassPath</font></a> <font
class="variable-name">cp</font> = ClassPath.<a
href="ClassPath.html#getClassPath-org.openide.filesystems.FileObject-java.lang.String-"><font
class="function-name">getClassPath</font></a>(f, ClassPath.<a
href="ClassPath.html#COMPILE"><font class="constant">COMPILE</font></a>);
cp.<a
href="ClassPath.html#addPropertyChangeListener-java.beans.PropertyChangeListener-"><font
class="function-name">addPropertyChangeListener</font></a>(new <a
href="@JDK@/java/beans/PropertyChangeListener.html"><font
class="type">PropertyChangeListener</font></a>() {
<font class="keyword">public void</font> <font
class="function-name">propertyChange</font>(<a
href="@JDK@/java/beans/PropertyChangeEvent.html"><font
class="type">PropertyChangeEvent</font></a> <font
class="variable-name">evt</font>) {
- <font class="keyword">if</font> (ClassPath.<a
href="ClassPath.html#PROP_ROOTS"><font
class="constant">PROP_ROOTS</font></a>.equals(evt.<a
href="@JDK@/java/beans/PropertyChangeEvent.html#getPropertyName()"><font
class="function-name">getPropertyName()</font></a>)) {
+ <font class="keyword">if</font> (ClassPath.<a
href="ClassPath.html#PROP_ROOTS"><font
class="constant">PROP_ROOTS</font></a>.equals(evt.<a
href="@JDK@/java/beans/PropertyChangeEvent.html#getPropertyName--"><font
class="function-name">getPropertyName()</font></a>)) {
<font class="comment">// Update your stuff, because classpath
roots have changed.</font>
}
}
diff --git
a/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/ClassPathProvider.java
b/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/ClassPathProvider.java
index fd0e1ccc2e..332ee75881 100644
---
a/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/ClassPathProvider.java
+++
b/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/ClassPathProvider.java
@@ -42,7 +42,7 @@ import org.openide.filesystems.FileObject;
* <li>The {@link ClassPath#BOOT} type of classpath
* is required or the source file will not be parsable and
* code completion will be disabled. See also
- * {@link
org.netbeans.spi.java.queries.SourceLevelQueryImplementation}.</li>
+ * <a
href="@org-netbeans-api-java@/org/netbeans/spi/java/queries/SourceLevelQueryImplementation.html">SourceLevelQueryImplementation</a>.</li>
* <li>The {@link ClassPath#SOURCE} type of classpath
* is required or code completion will be disabled.
* Providing this classpath will enable code completion, but only elements
@@ -60,7 +60,7 @@ import org.openide.filesystems.FileObject;
* {@link org.netbeans.api.java.classpath.GlobalPathRegistry}
* when they are to be exposed in the GUI as available for use (e.g. for the
editor's Fast Open dialog),
* and unregister them when they are no longer to be exposed. Typically this
is done as part of
- * <a
href="@org-netbeans-modules-projectuiapi@/org/netbeans/spi/project/ui/ProjectOpenedHook.html">ProjectOpenedHook</a>.
+ * <a
href="@org-netbeans-modules-projectuiapi-base@/org/netbeans/spi/project/ui/ProjectOpenedHook.html">ProjectOpenedHook</a>.
* <p>It is also desirable to produce classpath information for compiled class
files
* (bytecode), including their package roots (whether a disk folder or a JAR
root).
* This will enable parsing of the class files, which is sometimes needed
(e.g. for
diff --git
a/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/FlaggedClassPathImplementation.java
b/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/FlaggedClassPathImplementation.java
index d36e8c7f07..6218262926 100644
---
a/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/FlaggedClassPathImplementation.java
+++
b/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/FlaggedClassPathImplementation.java
@@ -24,7 +24,7 @@ import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.api.java.classpath.ClassPath;
/**
- * The ClassPathImplementation with {@link ClassPath.Flag}s.
+ * The ClassPathImplementation with {@link
org.netbeans.api.java.classpath.ClassPath.Flag}s.
* @author Tomas Zezula
* @since 1.44
*/
@@ -37,7 +37,7 @@ public interface FlaggedClassPathImplementation extends
ClassPathImplementation
/**
* Returns the {@link ClassPath}'s flags.
- * @return the {@link Flag}s
+ * @return the {@link org.netbeans.api.java.classpath.ClassPath.Flag}s
*/
@NonNull
Set<ClassPath.Flag> getFlags();
diff --git
a/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/support/ClassPathSupport.java
b/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/support/ClassPathSupport.java
index 147db3ae11..f14ff3455f 100644
---
a/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/support/ClassPathSupport.java
+++
b/ide/api.java.classpath/src/org/netbeans/spi/java/classpath/support/ClassPathSupport.java
@@ -133,7 +133,6 @@ public class ClassPathSupport {
* @throws IllegalArgumentException in case a path entry looks to be
invalid
* @since org.netbeans.api.java/1 1.15
* @see FileUtil#urlForArchiveOrDir
- * @see ClassPath#toJVMPath
*/
public static ClassPath createClassPath(String jvmPath) throws
IllegalArgumentException {
List<PathResourceImplementation> l = new
ArrayList<PathResourceImplementation>();
diff --git
a/ide/api.java.classpath/src/org/netbeans/spi/java/queries/BinaryForSourceQueryImplementation.java
b/ide/api.java.classpath/src/org/netbeans/spi/java/queries/BinaryForSourceQueryImplementation.java
index f0e21b6d4d..08ccfeaf7b 100644
---
a/ide/api.java.classpath/src/org/netbeans/spi/java/queries/BinaryForSourceQueryImplementation.java
+++
b/ide/api.java.classpath/src/org/netbeans/spi/java/queries/BinaryForSourceQueryImplementation.java
@@ -25,8 +25,8 @@ import org.netbeans.api.java.queries.BinaryForSourceQuery;
* Information about where binaries (classfiles) corresponding to
* Java sources can be found, this is intended to be the inverse of
* the SourceForBinaryQueryImplementation.
- * @see BinaryForSourceQuery
- * @see SourceForBinaryQuery
+ * @see org.netbeans.api.java.queries.BinaryForSourceQuery
+ * @see org.netbeans.api.java.queries.SourceForBinaryQuery
* @see SourceForBinaryQueryImplementation
* @since org.netbeans.api.java/1 1.12
* @author Tomas Zezula
@@ -46,12 +46,11 @@ public interface BinaryForSourceQueryImplementation {
* <li>Create a new BinaryForSourceQuery.Result for the sourceRoot, put it
into the cache
* and return it.</li>
* </ol>
- * </p>
* <p>
* Any absolute URL may be used but typically it will use the
<code>file</code>
* protocol for directory entries and <code>jar</code> protocol for JAR
entries
- * (e.g. <samp>jar:file:/tmp/foo.jar!/</samp>).
- * </p>
+ * (e.g. <code>jar:file:/tmp/foo.jar!/</code>).
+ *
* @param sourceRoot the source path root
* @return a result object encapsulating the answer or null if the
sourceRoot is not recognized
*/
diff --git
a/ide/api.java.classpath/src/org/netbeans/spi/java/queries/BinaryForSourceQueryImplementation2.java
b/ide/api.java.classpath/src/org/netbeans/spi/java/queries/BinaryForSourceQueryImplementation2.java
index 3b82fcb4c3..a1e6b975d3 100644
---
a/ide/api.java.classpath/src/org/netbeans/spi/java/queries/BinaryForSourceQueryImplementation2.java
+++
b/ide/api.java.classpath/src/org/netbeans/spi/java/queries/BinaryForSourceQueryImplementation2.java
@@ -35,7 +35,7 @@ import org.netbeans.modules.java.classpath.QueriesAccessor;
*
* @param <Result> any type this implementation wants to use as a result
* @see BinaryForSourceQuery
- * @see SourceForBinaryQuery
+ * @see org.netbeans.api.java.queries.SourceForBinaryQuery
* @see BinaryForSourceQueryImplementation
* @see SourceForBinaryQueryImplementation
* @since 1.58
@@ -45,7 +45,7 @@ public interface BinaryForSourceQueryImplementation2<Result>
extends BinaryForSo
/** Default
* implementation of {@link
BinaryForSourceQueryImplementation#findBinaryRoots(java.net.URL)}.
* Calls {@link #findBinaryRoots2(java.net.URL)} and if the method returns
non-{@code null}
- * value, then it creates instances of {@link
BinaryForSourceQuery.Result2} and returns
+ * value, then it creates instances of {@link
org.netbeans.api.java.queries.BinaryForSourceQuery.Result2} and returns
* it. Otherwise it returns {@code null}.
* <p>
* Override {@link #findBinaryRoots2(java.net.URL)}, not this method!
@@ -71,12 +71,12 @@ public interface
BinaryForSourceQueryImplementation2<Result> extends BinaryForSo
* return the {@link Object#equals(java.lang.Object) equal} result with the
* same {@link Object#hashCode()}. The implementation of the
* {@link #findBinaryRoots(java.net.URL)} method makes sure the same
- * {@link BinaryForSourceQuery.Result2} instance is returned for two
+ * {@link org.netbeans.api.java.queries.BinaryForSourceQuery.Result2}
instance is returned for two
* equal {@code Result} objects.
*
* @param sourceRoot the source path root
* @return {@code null} if the sourceRoot is not recognized, or any object
- * to feed into {@link #computeRoots(java.lang.Object)} & co. methods
+ * to feed into {@link #computeRoots(java.lang.Object)} & co. methods
* any time later
* @since 1.58
*/
diff --git
a/ide/api.java.classpath/src/org/netbeans/spi/java/queries/SourceForBinaryQueryImplementation.java
b/ide/api.java.classpath/src/org/netbeans/spi/java/queries/SourceForBinaryQueryImplementation.java
index 06c3de3f64..2abfad2817 100644
---
a/ide/api.java.classpath/src/org/netbeans/spi/java/queries/SourceForBinaryQueryImplementation.java
+++
b/ide/api.java.classpath/src/org/netbeans/spi/java/queries/SourceForBinaryQueryImplementation.java
@@ -54,8 +54,8 @@ import org.netbeans.api.java.queries.SourceForBinaryQuery;
* </ol>
* </div>
* @see org.netbeans.api.java.queries.SourceForBinaryQuery
- * @see org.netbeans.api.queries.FileOwnerQuery
- * @see org.netbeans.api.project.Project#getLookup
+ * @see <a
href="@org-netbeans-modules-projectapi@/org/netbeans/api/project/FileOwnerQuery.html">FileOwnerQuery</a>
+ * @see <a
href="@org-netbeans-modules-projectapi@/org/netbeans/api/project/Project.html#getLookup--">org.netbeans.api.project.Project#getLookup</a>
* @since org.netbeans.api.java/1 1.4
*/
public interface SourceForBinaryQueryImplementation {
@@ -73,11 +73,10 @@ public interface SourceForBinaryQueryImplementation {
* <li>Create a new SourceForBinaryQuery.Result for the binaryRoot, put it
into the cache
* and return it.</li>
* </ol>
- * </p>
* <p>
* Any absolute URL may be used but typically it will use the
<code>file</code>
* protocol for directory entries and <code>jar</code> protocol for JAR
entries
- * (e.g. <samp>jar:file:/tmp/foo.jar!/</samp>).
+ * (e.g. <code>jar:file:/tmp/foo.jar!/</code>).
* </p>
* @param binaryRoot the class path root of Java class files
* @return a result object encapsulating the answer or null if the
binaryRoot is not recognized
diff --git
a/ide/api.java.classpath/src/org/netbeans/spi/java/queries/support/SourceForBinaryQueryImpl2Base.java
b/ide/api.java.classpath/src/org/netbeans/spi/java/queries/support/SourceForBinaryQueryImpl2Base.java
index c57f054903..a66db76af6 100644
---
a/ide/api.java.classpath/src/org/netbeans/spi/java/queries/support/SourceForBinaryQueryImpl2Base.java
+++
b/ide/api.java.classpath/src/org/netbeans/spi/java/queries/support/SourceForBinaryQueryImpl2Base.java
@@ -26,20 +26,20 @@ import org.openide.util.Parameters;
/**
* Base class for {@link SourceForBinaryQueryImplementation2} which need to
delegate
- * to other {@link SourceForBinaryQueryImplementation}.
+ * to other {@link
org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation}.
* @since 1.16
* @author Tomas Zezula
*/
public abstract class SourceForBinaryQueryImpl2Base implements
SourceForBinaryQueryImplementation2 {
/**
- * Creates a wrapper for {@link SourceForBinaryQuery.Result}. This method
+ * Creates a wrapper for {@link
org.netbeans.api.java.queries.SourceForBinaryQuery.Result}. This method
* should be used by delegating {@link SourceForBinaryQueryImplementation2}
- * which need to delegate to {@link SourceForBinaryQueryImplementation}.
- * @param result returned by {@link SourceForBinaryQueryImplementation},
- * When result is already instanceof {@link
SourceForBinaryQueryImplementation2.Result}
+ * which need to delegate to {@link
org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation}.
+ * @param result returned by {@link
org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation},
+ * When result is already instanceof {@link
org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation2.Result}
* it's returned without wrapping.
- * @return a {@link SourceForBinaryQueryImplementation2.Result}.
+ * @return a {@link
org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation2.Result}.
*/
protected final Result asResult (SourceForBinaryQuery.Result result) {
Parameters.notNull("result", result); //NOI18N
diff --git a/ide/api.lsp/apichanges.xml b/ide/api.lsp/apichanges.xml
index bd810db278..c65b589a2e 100644
--- a/ide/api.lsp/apichanges.xml
+++ b/ide/api.lsp/apichanges.xml
@@ -101,7 +101,7 @@
<author login="sdedic"/>
<compatibility binary="compatible" source="compatible" addition="yes"
deletion="no"/>
<description>
- <a
href="@TOP@/org/netbeans/spi/lsp/CallHiearchyProvider.html">CallHierarchyProvider</a>
SPI allows to trace incoming and
+ <a
href="@TOP@/org/netbeans/spi/lsp/CallHierarchyProvider.html">CallHierarchyProvider</a>
SPI allows to trace incoming and
outgoing calls. <a
href="@TOP@/org/netbeans/api/lsp/CallHierarchyEntry.html">CallHierarchyEntry</a>
describes a specific call site
or target.
</description>
@@ -133,7 +133,7 @@
An <code>ErrorProvider.Context.getOffset()</code> method
introduced that allows to
compute hint for a given file offset.
</description>
- <class package="org.netbeans.api.lsp" name="ErrorProvider"/>
+ <class package="org.netbeans.spi.lsp" name="ErrorProvider"/>
</change>
<change id="ErrorProvider">
<api name="LSP_API"/>
@@ -146,7 +146,7 @@
An <code>ErrorProvider</code> interface introduced that allows to
compute errors/warnings for a given file.
</description>
- <class package="org.netbeans.api.lsp" name="ErrorProvider"/>
+ <class package="org.netbeans.spi.lsp" name="ErrorProvider"/>
</change>
<change id="HoverProvider">
<api name="LSP_API"/>
diff --git a/ide/api.lsp/src/org/netbeans/api/lsp/CallHierarchyEntry.java
b/ide/api.lsp/src/org/netbeans/api/lsp/CallHierarchyEntry.java
index 998749e6c7..5b82cce358 100644
--- a/ide/api.lsp/src/org/netbeans/api/lsp/CallHierarchyEntry.java
+++ b/ide/api.lsp/src/org/netbeans/api/lsp/CallHierarchyEntry.java
@@ -44,7 +44,7 @@ public final class CallHierarchyEntry {
private String customData;
/**
- * Returns description of the call hierarchy element. See {@link
StructureElemen} for structure details,
+ * Returns description of the call hierarchy element. See {@link
StructureElement} for structure details,
* @return description of the structural languagein call hierarchy
*/
@NonNull
@@ -76,7 +76,7 @@ public final class CallHierarchyEntry {
/**
* This structure is used for two purposes. For <b>outgoing calls</b> the
{@link #getItem}
* returns the call target, and {@link #getRanges} returns locations in
the origin
- * {@link CallHierarchyElement} where the target is invoked from. For
<b>incoming calls</b>
+ * {@link CallHierarchyEntry} where the target is invoked from. For
<b>incoming calls</b>
* the {@link #getItem} identifies the element that makes the call, while
{@link #getRanges}
* locations where the call was made from from that element.
*
diff --git a/ide/api.lsp/src/org/netbeans/api/lsp/CodeAction.java
b/ide/api.lsp/src/org/netbeans/api/lsp/CodeAction.java
index 25465d8469..a9493f5277 100644
--- a/ide/api.lsp/src/org/netbeans/api/lsp/CodeAction.java
+++ b/ide/api.lsp/src/org/netbeans/api/lsp/CodeAction.java
@@ -52,7 +52,7 @@ public class CodeAction {
/**
* Construct the {@code CodeAction}.
*
- * @param text the name of the action
+ * @param title the name of the action
* @param command the command that should be invoked
* @param edit the {@code WorkspaceEdit} that should be performed
*/
diff --git a/ide/api.lsp/src/org/netbeans/api/lsp/Diagnostic.java
b/ide/api.lsp/src/org/netbeans/api/lsp/Diagnostic.java
index 9f8cbaab0d..1f9ceebb14 100644
--- a/ide/api.lsp/src/org/netbeans/api/lsp/Diagnostic.java
+++ b/ide/api.lsp/src/org/netbeans/api/lsp/Diagnostic.java
@@ -138,8 +138,8 @@ public class Diagnostic {
/**
* Create a new {@code Builder}
*
- * @param startOffset the start offset of the diagnostic
- * @param endOffset the end offset of the diagnostic
+ * @param startPosition the start offset of the diagnostic
+ * @param endPosition the end offset of the diagnostic
* @param description the description of the diagnostic
* @return a new builder
*/
diff --git a/ide/api.lsp/src/org/netbeans/spi/lsp/CallHierarchyProvider.java
b/ide/api.lsp/src/org/netbeans/spi/lsp/CallHierarchyProvider.java
index e884dd7727..28ef57c0a3 100644
--- a/ide/api.lsp/src/org/netbeans/spi/lsp/CallHierarchyProvider.java
+++ b/ide/api.lsp/src/org/netbeans/spi/lsp/CallHierarchyProvider.java
@@ -32,8 +32,8 @@ import org.netbeans.api.lsp.CallHierarchyEntry;
* <p>
* First {@link #findCallOrigin} should be called, producing a {@link
CallHierarchyEntry}
* that describes the element at the given position. In subsequent calls,
inbound or
- * outbound calls may be inspected for the passed Entry using {@link
#findIncomingCalls}
- * or {@link #findOugoingCalls}.
+ * outbound calls may be inspected for the passed Entry using {@link
#findIncomingCalls(CallHierarchyEntry)}
+ * or {@link #findOutgoingCalls(CallHierarchyEntry)}.
* <p>
* Note that the returned CompletableFutures may become completed cancelled if
the implementation (for example)
* displays user-facing UI like progress, which allows the user to interrupt
the operation. If the reported
@@ -60,7 +60,7 @@ public interface CallHierarchyProvider {
/**
* Returns a list of locations that call into the passed call target. The
method may return {@code null}, if the
* call target location is not supported or is invalid. The {@link
CallHierarchyEntry.Call#getRanges() Call.getRanges()}
- * describes ranges int he caller {@link StructureElement} where the
target is invoked.
+ * describes ranges int he caller {@link
org.netbeans.api.lsp.StructureElement} where the target is invoked.
* @param callTarget the call target location
* @return list of callers, or {@code null}
*/
@@ -70,7 +70,7 @@ public interface CallHierarchyProvider {
/**
* Returns a list of locations that are called from the passed source. The
method may return {@code null}, if the
* call target location is not supported or is invalid. The {@link
CallHierarchyEntry.Call#getRanges() Call.getRanges()}
- * describe ranges in the call source, where the specific {@link
StructureElement} target is called from.
+ * describe ranges in the call source, where the specific {@link
org.netbeans.api.lsp.StructureElement} target is called from.
* @param callSource the location to inspect
* @return list of callees, or {@code null}
*/
diff --git a/ide/api.lsp/src/org/netbeans/spi/lsp/CompletionCollector.java
b/ide/api.lsp/src/org/netbeans/spi/lsp/CompletionCollector.java
index 781e05e8b6..e524d8619a 100644
--- a/ide/api.lsp/src/org/netbeans/spi/lsp/CompletionCollector.java
+++ b/ide/api.lsp/src/org/netbeans/spi/lsp/CompletionCollector.java
@@ -248,7 +248,7 @@ public interface CompletionCollector {
/**
* The format of the insert text. The format applies to both the
* {@code insertText} property and the {@code newText} property of a
provided
- * {@code textEdit}. If omitted defaults to {@link
TextFormat#PlainText}.
+ * {@code textEdit}. If omitted defaults to {@link
org.netbeans.api.lsp.Completion.TextFormat#PlainText}.
*
* @since 1.0
*/
diff --git a/ide/api.lsp/src/org/netbeans/spi/lsp/ErrorProvider.java
b/ide/api.lsp/src/org/netbeans/spi/lsp/ErrorProvider.java
index 773df2563e..577aee3e22 100644
--- a/ide/api.lsp/src/org/netbeans/spi/lsp/ErrorProvider.java
+++ b/ide/api.lsp/src/org/netbeans/spi/lsp/ErrorProvider.java
@@ -143,7 +143,8 @@ public interface ErrorProvider {
* The kind of errors/warnings that should be computed. {@code ERRORS} is
* intended to compute more significant diagnostics quicker, {@code HINTS}
* is inteded to compute less significant diagnostics at the cost of taking
- * longer. The {@link Severity} of {@link ErrorDescription} reported for
neither
+ * longer. The <a
href="@org-netbeans-spi-editor-hints@/org/netbeans/spi/editor/hints/Severity.html">Severity</a>
+ * of <a
href="@org-netbeans-spi-editor-hints@/org/netbeans/spi/editor/hints/ErrorDescription.html">ErrorDescription</a>
reported for neither
* of these is limited.
*/
public enum Kind {
diff --git
a/ide/api.xml/src/org/netbeans/api/xml/parsers/DocumentInputSource.java
b/ide/api.xml/src/org/netbeans/api/xml/parsers/DocumentInputSource.java
index 6a32758ce6..753e28a076 100644
--- a/ide/api.xml/src/org/netbeans/api/xml/parsers/DocumentInputSource.java
+++ b/ide/api.xml/src/org/netbeans/api/xml/parsers/DocumentInputSource.java
@@ -71,7 +71,7 @@ public final class DocumentInputSource extends InputSource {
* <li>use client's <code>setSystemId()</code>, or
* <li>try to derive it from <code>Document</code>
* <p>e.g. look at <code>Document.StreamDescriptionProperty</code> for
- * {@link DataObject} and use URL of its primary file.
+ * <a
href="@org-openide-loaders@/org/openide/loaders/DataObject.html">DataObject</a>
and use URL of its primary file.
* </ul>
* @return entity system Id or <code>null</code>
*/
diff --git a/ide/editor.util/apichanges.xml b/ide/editor.util/apichanges.xml
index 3592a08fc2..73b8bd615f 100644
--- a/ide/editor.util/apichanges.xml
+++ b/ide/editor.util/apichanges.xml
@@ -408,7 +408,7 @@ is the proper place.
<p>
The present classes were repackaged from
org.netbeans.modules.editor.util
into org.netbeans.lib.editor.util package to fulfil the editor
module
- split proposal <a
href="http://www.netbeans.org/issues/show_bug.cgi?id=51486">#51486</a>
+ split proposal <a
href="https://bz.apache.org/netbeans/show_bug.cgi?id=51486">#51486</a>
according to which the editor classes independent of the NB IDE
should be placed under org.netbeans.lib package.
</p>
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/AbstractCharSequence.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/AbstractCharSequence.java
index 5c0277c779..5859bba2b2 100644
--- a/ide/editor.util/src/org/netbeans/lib/editor/util/AbstractCharSequence.java
+++ b/ide/editor.util/src/org/netbeans/lib/editor/util/AbstractCharSequence.java
@@ -32,7 +32,7 @@ public abstract class AbstractCharSequence implements
CharSequence {
/**
* Returns the length of this character sequence. The length is the number
- * of 16-bit Unicode characters in the sequence. </p>
+ * of 16-bit Unicode characters in the sequence.
*
* @return the number of characters in this sequence
*/
@@ -42,7 +42,7 @@ public abstract class AbstractCharSequence implements
CharSequence {
* Returns the character at the specified index. An index ranges from zero
* to <tt>length() - 1</tt>. The first character of the sequence is at
* index zero, the next at index one, and so on, as for array
- * indexing. </p>
+ * indexing.
*
* @param index the index of the character to be returned
*
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/ArrayUtilities.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/ArrayUtilities.java
index fca54e99bb..4d6d4ed650 100644
--- a/ide/editor.util/src/org/netbeans/lib/editor/util/ArrayUtilities.java
+++ b/ide/editor.util/src/org/netbeans/lib/editor/util/ArrayUtilities.java
@@ -189,7 +189,7 @@ public final class ArrayUtilities {
/**
* Return unmodifiable list for the given array.
- * <br/>
+ * <br>
* Unlike <code>Collections.unmodifiableList()</code> this method
* does not use any extra wrappers etc.
*
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/CharSequenceUtilities.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/CharSequenceUtilities.java
index cb4d8a90a5..1ee8a7161f 100644
---
a/ide/editor.util/src/org/netbeans/lib/editor/util/CharSequenceUtilities.java
+++
b/ide/editor.util/src/org/netbeans/lib/editor/util/CharSequenceUtilities.java
@@ -122,9 +122,9 @@ public final class CharSequenceUtilities {
* Create string for the given portion of the character sequence.
*
* @param text non-null text.
- * @param start >=0 and <text.length() index of the first character
+ * @param start >=0 and <text.length() index of the first character
* to be present in the returned string.
- * @param end >=start and <text.length() index after the last character
+ * @param end >=start and <text.length() index after the last
character
* to be present in the returned string.
*/
public static String toString(CharSequence text, int start, int end) {
@@ -136,7 +136,7 @@ public final class CharSequenceUtilities {
/**
* Append character sequence to the given string buffer.
- * <br/>
+ * <br>
* This method is no longer needed in JDK 1.5 where the implementation
* does not create an extra java.lang.String instance.
*/
@@ -146,7 +146,7 @@ public final class CharSequenceUtilities {
/**
* Append part of the character sequence to the given string buffer.
- * <br/>
+ * <br>
* This method is no longer needed in JDK 1.5 where the implementation
* of the same functionality is available in the StringBuffer directly.
*/
diff --git a/ide/editor.util/src/org/netbeans/lib/editor/util/CompactMap.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/CompactMap.java
index e567269596..bd46275ccf 100644
--- a/ide/editor.util/src/org/netbeans/lib/editor/util/CompactMap.java
+++ b/ide/editor.util/src/org/netbeans/lib/editor/util/CompactMap.java
@@ -31,25 +31,25 @@ import java.util.Set;
/**
* Map implementation that allows to define the class that implements
* the <code>Map.Entry</code>.
- * <br/>
+ * <br>
* The present implementation does not allow <code>null</code> to be used
* as a key in the map. The client may use NULL_KEY masking on its own side
* if it wants to use null keys (see <code>java.util.HashMap</code> impl).
- * <br/>
+ * <br>
* The load factor is fixed to <code>1.0</code> but if the approximate map size
* is known there is a constructor that allows to pass the initial capacity.
- * <br/>
+ * <br>
* There are no additional attempts to generally improve hashing for poor
hashing functions
* like those in <code>HashMap.hash()</code>.
- * <br/>
+ * <br>
* The iterators produced by this map are not fail-fast - they will continue
iteration
* and their behavior is generally undefined after the modification.
* The caller should ensure that there will be no pending iterators during
modification
* of this map.
- * <br/>
+ * <br>
* When iterating through entries in a bucket the <code>Object.equals()</code>
* is used for comparison.
- * <br/>
+ * <br>
*
* @author Miloslav Metelka
* @version 1.00
@@ -82,7 +82,7 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Get an entry from a bucket that corresponds to the given hash code.
- * <br/>
+ * <br>
* This may be useful if the hash code can be computed without creating
* an actual object being stored in the map. The target object should
* provide some method for comparing itself to the passed arguments that
represent
@@ -117,12 +117,12 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Put the given entry into the map.
- * <br/>
+ * <br>
* The given entry should only be added to one compact map instance.
- * <br/>
+ * <br>
* Adding a single entry into multiple compact maps will break
* internal consistency of all the intended maps!
- * <br/>
+ * <br>
* If there will be an existing entry with a key that equals to the key
* in the entry parameter then the original entry will be replaced
* by the given entry.
@@ -193,7 +193,7 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Remove the given entry from the map.
- * <br/>
+ * <br>
* This method will search for the entry instance (not its key)
* so the given entry must be physically used in the map
* otherwise this method will not do anything.
@@ -346,7 +346,7 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Abstract implementation of the map entry.
- * <br/>
+ * <br>
* This is suitable for the cases when e.g. the value is a primitive
* data type.
*/
@@ -365,7 +365,7 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Used by {@link #hashCode()} to return the real hashCode for the
value
* held by this map entry.
- * <br/>
+ * <br>
* <code>getValue().hashCode</code> cannot be used in general because
* <code>getValue()</code> may return <code>this</code> e.g. in case
* the value is represented by primitive data type. The method should
@@ -376,7 +376,7 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Used by {@link #equals(Object)} to check whether the value
* held by this map entry equals to the the given value.
- * <br/>
+ * <br>
* <code>getValue().equals()</code> cannot be used in general because
* <code>getValue()</code> may return <code>this</code> e.g. in case
* the value is represented by primitive data type. The method should
@@ -390,7 +390,7 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Get next map entry linked to this one.
- * <br/>
+ * <br>
* This method may be useful after using {@link #getFirstEntry(int)}.
*/
public final MapEntry<K,V> nextMapEntry() {
@@ -403,7 +403,7 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Get stored hash code of the key contained in this entry.
- * <br/>
+ * <br>
* This method may be useful after using {@link #getFirstEntry(int)}
* to quickly exclude entries which hash code differs from the
requested one.
*/
@@ -448,7 +448,7 @@ public class CompactMap<K,V> implements Map<K,V> {
/**
* Default implementation of the map entry similar to e.g. the
<code>HashMap</code>.
- * <br/>
+ * <br>
* It may be extended as well if the should be an additional information
stored
* in the map entry.
*/
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/FlyOffsetGapList.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/FlyOffsetGapList.java
index 4f38bc3f29..f567da1cc2 100644
--- a/ide/editor.util/src/org/netbeans/lib/editor/util/FlyOffsetGapList.java
+++ b/ide/editor.util/src/org/netbeans/lib/editor/util/FlyOffsetGapList.java
@@ -86,10 +86,10 @@ public abstract class FlyOffsetGapList<E> extends
GapList<E> {
* Return base starting offset to which all the tokens contained in this
list
* are related. The absolute token's offset is a sum of this start offset
plus
* token's offset.
- * <br/>
+ * <br>
* There may be just flyweight element(s) at the begining of the list
* so the start offset gives the necessary basing.
- * <br/>
+ * <br>
* By default it's zero.
*/
protected int startOffset() {
@@ -357,7 +357,7 @@ public abstract class FlyOffsetGapList<E> extends
GapList<E> {
/**
* This method updates element's offset (shifts it above offset gap if
necessary)
* before adding the element to the list.
- * <bt/>
+ * <br>
* This method should be called before (or after) the element is
physically added
* to the list. If the element is added below the offset gap
* then calling of this method is not necessary.
@@ -372,11 +372,11 @@ public abstract class FlyOffsetGapList<E> extends
GapList<E> {
/**
* This method updates element's offset (shifts it below offset gap if
necessary)
* before (or after) the element gets removed from the list.
- * <br/>
+ * <br>
* This method should be called after the element is physically removed
* from the list and it's desired that it retains its natural offset
* (not possibly shifted by the offset gap length).
- * <br/>
+ * <br>
* If the element was located below the offset gap prior removal
* then calling of this method is not necessary.
*/
diff --git a/ide/editor.util/src/org/netbeans/lib/editor/util/ListenerList.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/ListenerList.java
index 4e9f3865f5..9a435409b3 100644
--- a/ide/editor.util/src/org/netbeans/lib/editor/util/ListenerList.java
+++ b/ide/editor.util/src/org/netbeans/lib/editor/util/ListenerList.java
@@ -58,11 +58,12 @@ public final class ListenerList<T extends EventListener>
implements Serializable
* for firing events to all the listeners you get from this
* method.
*
- * <pre>
+ * <pre>{@code
* List<MyListener> listeners = listenerList.getListeners();
* for (MyListener l : listeners) {
* l.notify(evt);
* }
+ * }
* </pre>
*
* @return An immutable list of listeners contained in this listener list.
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/OffsetGapList.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/OffsetGapList.java
index 28ffb3433e..c0fdd1149b 100644
--- a/ide/editor.util/src/org/netbeans/lib/editor/util/OffsetGapList.java
+++ b/ide/editor.util/src/org/netbeans/lib/editor/util/OffsetGapList.java
@@ -305,7 +305,7 @@ public abstract class OffsetGapList<E> extends GapList<E> {
/**
* This method updates element's offset (shifts it above offset gap if
necessary)
* before adding the element to the list.
- * <bt/>
+ * <br>
* This method should be called before (or after) the element is
physically added
* to the list. If the element is added below the offset gap
* then calling of this method is not necessary.
@@ -320,11 +320,11 @@ public abstract class OffsetGapList<E> extends GapList<E>
{
/**
* This method updates element's offset (shifts it below offset gap if
necessary)
* before (or after) the element gets removed from the list.
- * <br/>
+ * <br>
* This method should be called after the element is physically removed
* from the list and it's desired that it retains its natural offset
* (not possibly shifted by the offset gap length).
- * <br/>
+ * <br>
* If the element was located below the offset gap prior removal
* then calling of this method is not necessary.
*/
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/BlockCompare.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/BlockCompare.java
index 74ce6c2596..12ec4fc469 100644
--- a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/BlockCompare.java
+++ b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/BlockCompare.java
@@ -66,7 +66,7 @@ public final class BlockCompare {
/**
* Check if block X is before block Y.
*
- * @return true if end offset of block X is <= start offset of block Y
i.e.<br/>
+ * @return true if end offset of block X is <= start offset of block Y
i.e.<br>
* xEndOffset <= yStartOffset.
*
*/
@@ -77,7 +77,7 @@ public final class BlockCompare {
/**
* Check if block X is after block Y.
*
- * @return true if start offset of block X is >= end offset of block Y
i.e.<br/>
+ * @return true if start offset of block X is >= end offset of block Y
i.e.<br>
* xStartOffset >= yEndOffset.
*
*/
@@ -144,8 +144,8 @@ public final class BlockCompare {
* Check if block X overlaps block Y at its begining.
*
* @return true if start offset of block X is before start offset of block
Y
- * and end offset of block X is inside block Y i.e.<br/>
- * xStartOffset < yStartOffset and <br/>
+ * and end offset of block X is inside block Y i.e.<br>
+ * xStartOffset < yStartOffset and <br>
* xEndOffset > yStartOffset and xEndOffset < yEndOffset.
*/
public boolean overlapStart() {
@@ -156,8 +156,8 @@ public final class BlockCompare {
* Check if block X overlaps block Y at its end.
*
* @return true if start offset of block X is inside block Y
- * and end offset of block X is above end of block Y i.e.<br/>
- * xStartOffset > yStartOffset && xStartOffset < yEndOffset<br/>
+ * and end offset of block X is above end of block Y i.e.<br>
+ * xStartOffset > yStartOffset && xStartOffset <
yEndOffset<br>
* xEndOffset > yEndOffset.
*/
public boolean overlapEnd() {
@@ -185,9 +185,9 @@ public final class BlockCompare {
/**
* Check if block X has invalid bounds (start offset higher than its end
offset).
*
- * @return true if X has start offset higher than end offset i.e.<br/>
+ * @return true if X has start offset higher than end offset i.e.<br>
* xStartOffset > xEndOffset.
- * <br/>
+ * <br>
* If true the block is treated as empty (end offset value is explicitly
corrected to the start offset value)
* and the rest of flags is set accordingly.
* @since 1.49
@@ -199,9 +199,9 @@ public final class BlockCompare {
/**
* Check if block Y has invalid bounds (start offset higher than its end
offset).
*
- * @return true if Y has start offset higher than end offset i.e.<br/>
+ * @return true if Y has start offset higher than end offset i.e.<br>
* yStartOffset > yEndOffset.
- * <br/>
+ * <br>
* If true the block is treated as empty (end offset value is explicitly
corrected to the start offset value)
* and the rest of flags is set accordingly.
* @since 1.49
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/DocumentListenerPriority.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/DocumentListenerPriority.java
index a41b3b6eb5..58e64d98c7 100644
---
a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/DocumentListenerPriority.java
+++
b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/DocumentListenerPriority.java
@@ -30,7 +30,7 @@ public final class DocumentListenerPriority {
/**
* Level that gets notified first (before all other levels).
- * <br/>
+ * <br>
* It may be used in cooperation with other levels to pre-mark that there
was
* a document modification performed that may change some of the data
* that will be updated later on another level. For example the view
hierarchy
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/DocumentUtilities.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/DocumentUtilities.java
index 05cecf0cbb..a8b51507a4 100644
---
a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/DocumentUtilities.java
+++
b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/DocumentUtilities.java
@@ -97,7 +97,7 @@ public final class DocumentUtilities {
* Suitable for document implementations - adds document listener
* to document with given priority and does not do anything
* if the given document is not listener priority aware.
- * <br/>
+ * <br>
* Using this method in the document impls and defaulting
* to super.addDocumentListener() in case it returns false
* will ensure that there won't be an infinite loop in case the super
constructors
@@ -141,7 +141,7 @@ public final class DocumentUtilities {
* Suitable for document implementations - removes document listener
* from document with given priority and does not do anything
* if the given document is not listener priority aware.
- * <br/>
+ * <br>
* Using this method in the document impls and defaulting
* to super.removeDocumentListener() in case it returns false
* will ensure that there won't be an infinite loop in case the super
constructors
@@ -209,7 +209,7 @@ public final class DocumentUtilities {
/**
* Get total count of document listeners attached to a particular document
* (useful e.g. for logging).
- * <br/>
+ * <br>
* If the document uses priority listening then get the count of listeners
* at all levels. If the document is not {@link AbstractDocument} the
method
* returns zero.
@@ -231,7 +231,7 @@ public final class DocumentUtilities {
* by user's typing.
* It should be used by default-key-typed-action and the actions
* for backspace and delete keys.
- * <br/>
+ * <br>
* The document listeners being fired may
* query it by using {@link #isTypingModification(Document)}.
* This method should always be used in the following pattern:
@@ -253,7 +253,7 @@ public final class DocumentUtilities {
/**
* This method should be used by document listeners to check whether
* the just performed document modification was caused by user's typing.
- * <br/>
+ * <br>
* Certain functionality such as code completion or code templates
* may benefit from that information. For example the java code completion
* should only react to the typed "." but not if the same string was e.g.
@@ -394,7 +394,7 @@ public final class DocumentUtilities {
/**
* Set a property of a given document event by using the given map entry.
- * <br/>
+ * <br>
* The present implementation is able to directly store instances
* of <code>CompactMap.MapEntry</code>. Other map entry implementations
* will be delegated to {@link #putEventProperty(DocumentEvent, Object,
Object)}.
@@ -441,7 +441,7 @@ public final class DocumentUtilities {
/**
* Get text of the given document modification.
- * <br/>
+ * <br>
* It's implemented as retrieving of a <code>String.class</code>.
*
* @param evt document event describing either document insertion or
removal
@@ -458,10 +458,10 @@ public final class DocumentUtilities {
* Check whether the given document is read-locked by at least one thread
* or whether it was write-locked by the current thread (write-locking
* grants the read-access automatically).
- * <br/>
+ * <br>
* The method currently only works for {@link
javax.swing.text.AbstractDocument}
* based documents and it uses reflection.
- * <br/>
+ * <br>
* Unfortunately the AbstractDocument only records number of read-lockers
* but not the thread references that performed the read-locking. Thus it
can't be verified
* whether current thread has performed read locking or another thread.
@@ -503,7 +503,7 @@ public final class DocumentUtilities {
/**
* Check whether the given document is write-locked by the current thread.
- * <br/>
+ * <br>
* The method currently only works for {@link
javax.swing.text.AbstractDocument}
* based documents and it uses reflection.
*
@@ -881,7 +881,7 @@ public final class DocumentUtilities {
* @param doc The document to get the mime type for.
*
* @return The mime type of the document or <code>null</code>.
- * @see org.netbeans.modules.editor.NbEditorDocument#MIME_TYPE_PROP
+ * @see <a
href="@org-netbeans-modules-editor-lib@/org/netbeans/editor/BaseDocument.html#MIME_TYPE_PROP"
>NbEditorDocument#MIME_TYPE_PROP</a>
* @since 1.23
*/
public static String getMimeType(Document doc) {
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/MutablePositionRegion.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/MutablePositionRegion.java
index 0bd7e484ed..89c37d11b3 100644
---
a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/MutablePositionRegion.java
+++
b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/MutablePositionRegion.java
@@ -27,7 +27,7 @@ import javax.swing.text.Position;
/**
* A pair of positions delimiting a text region in a swing document.
- * <br/>
+ * <br>
* At all times it should be satisfied that
* {@link #getStartOffset()} <= {@link #getEndOffset()}.
*
@@ -57,7 +57,7 @@ public class MutablePositionRegion extends PositionRegion {
/**
* Set a new start and end positions of this region.
- * <br/>
+ * <br>
* They should satisfy
* {@link #getStartOffset()} <= {@link #getEndOffset()}.
*
@@ -70,7 +70,7 @@ public class MutablePositionRegion extends PositionRegion {
/**
* Set a new start position of this region.
- * <br/>
+ * <br>
* It should satisfy
* {@link #getStartOffset()} <= {@link #getEndOffset()}.
*
@@ -82,7 +82,7 @@ public class MutablePositionRegion extends PositionRegion {
/**
* Set a new end position of this region.
- * <br/>
+ * <br>
* It should satisfy
* {@link #getStartOffset()} <= {@link #getEndOffset()}.
*
diff --git
a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/PositionRegion.java
b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/PositionRegion.java
index df2e8ee074..aa37f016ca 100644
--- a/ide/editor.util/src/org/netbeans/lib/editor/util/swing/PositionRegion.java
+++ b/ide/editor.util/src/org/netbeans/lib/editor/util/swing/PositionRegion.java
@@ -27,7 +27,7 @@ import javax.swing.text.Position;
/**
* A pair of positions delimiting a text region in a swing document.
- * <br/>
+ * <br>
* At all times it should be satisfied that
* {@link #getStartOffset()} <= {@link #getEndOffset()}.
*
@@ -60,7 +60,7 @@ public class PositionRegion {
/**
* Create a fixed position instance that just wraps a given integer offset.
- * <br/>
+ * <br>
* This may be useful for situations where a position needs to be used
* but the document is not available yet. Once the document becomes
* available the regular position instance (over an existing document)
diff --git a/platform/api.templates/arch.xml b/platform/api.templates/arch.xml
index 64f54ea886..2ccae1419d 100644
--- a/platform/api.templates/arch.xml
+++ b/platform/api.templates/arch.xml
@@ -126,6 +126,7 @@
</p>
</usecase>
<usecase id="script" name="Using Scripting and Templating Languages" >
+ <a id="script"></a>
<p>
There is a built in <a
href="@org-netbeans-api-scripting@/overview-summary.html">support for scripting
languages</a>
in the NetBeans Platform. If a template is annotated with
@@ -134,7 +135,7 @@
return real instance of <code>ScriptEngine</code> interface or
a <code>String</code> name of the engine that is then used to
search for it in the <code>javax.script.ScriptEngineManager</code>.
- Usually the <a
href="https://freemarker.apache.org/">freemarker</a> engine is the one that is
+ Usually the <a href="https://freemarker.apache.org">freemarker</a>
engine is the one that is
supported by the NetBeans IDE - if your module wants to use it
then include a token dependency <code>OpenIDE-Module-Needs:
javax.script.ScriptEngine.freemarker</code>
in your manifest file (also accessible through project customizer
GUI)
@@ -230,7 +231,7 @@
should be of type String and its content should be snippet of
JavaScript code to execute inside of your specified HTML page
(e.g. <code>x.html</code>) to create an instance of
- <a href="http://knockoutjs.com">KnockoutJS model</a> to
+ <a href="https://knockoutjs.com">KnockoutJS model</a> to
drive the wizard. Here is a sample code for the model:
</p>
<pre>
@@ -260,7 +261,7 @@
proprietary text value <code>msg</code> which is
going to be filled by the wizard and cannot be empty. Each
page of the wizard is registered using a custom
- <a href="http://knockoutjs.com">Knockout.js</a> binding called
+ <a href="https://knockoutjs.com">Knockout.js</a> binding called
<code>step</code>. Here is an HTML page defining three steps:
</p>
<pre>
@@ -339,8 +340,8 @@ I feel ${wizard.msg}.
way to rewrite the <a href="#html-and-js">HTML and JavaScript
sample</a>
to <b>Java</b>
(and possibly run it in a plugin-less browser via
- <a onclick="target='_blank'"
href="http://bck2brwsr.apidesign.org">bck2brwsr VM</a>). Keep the
- same HTML, <a onclick="target='_blank'"
href="http://freemarker.org/">Freemarker</a>, etc.
+ <a href="http://wiki.apidesign.org/wiki/Bck2Brwsr">bck2brwsr
VM</a>). Keep the
+ same HTML, <a href="https://freemarker.apache.org">Freemarker</a>,
etc.
files - just instead of encoding the logic in JavaScript use Java:
</p>
<pre>
@@ -374,9 +375,9 @@ I feel ${wizard.msg}.
</pre>
<p>
The return value of the annotated method is now an
- <a onclick="target='_blank'"
href="http://bits.netbeans.org/html+java/">HTML/Java</a>
+ <a href="https://bits.netbeans.org/html+java/dev">HTML/Java</a>
model class which can naturally represent the essential
- <a onclick="target='_blank'" href="http://knockoutjs.com">Knockout.js</a>
objects
+ <a href="https://knockoutjs.com">Knockout.js</a> objects
in Java.
</p>
</usecase>
diff --git
a/platform/api.templates/src/org/netbeans/api/templates/CreateFromTemplateDecorator.java
b/platform/api.templates/src/org/netbeans/api/templates/CreateFromTemplateDecorator.java
index 8e72f9ab71..4a8fee8c68 100644
---
a/platform/api.templates/src/org/netbeans/api/templates/CreateFromTemplateDecorator.java
+++
b/platform/api.templates/src/org/netbeans/api/templates/CreateFromTemplateDecorator.java
@@ -31,7 +31,7 @@ import org.openide.util.Lookup;
* file is processed and after it is processed, depending on {@link
#isBeforeCreation()}
* and {@link #isAfterCreation()} return values. A decorator may perform both
pre- and post-
* processing.
- * <p/>
+ * <p>
* First the decorator is asked to {@link #accept} the creation process; if it
does not,
* it will not be invoked at all. Before/after main file creation the {@link
#decorate}
* method is called to perform its magic. Any reported additional files will
be returned
@@ -66,7 +66,7 @@ public interface CreateFromTemplateDecorator {
* Extends the creation process. The decorator may alter the created file
(it is the first in the
* returned list) or create additional files. In case it creates files, it
must return list of the
* added files.
- * <p/>
+ * <p>
* If the decorator is not interested, it should return simply {@code
null}.
*
* @param desc command objects that describes the file creation request
diff --git
a/platform/api.templates/src/org/netbeans/api/templates/TemplateRegistration.java
b/platform/api.templates/src/org/netbeans/api/templates/TemplateRegistration.java
index 0aef36b407..e13abc6cd2 100644
---
a/platform/api.templates/src/org/netbeans/api/templates/TemplateRegistration.java
+++
b/platform/api.templates/src/org/netbeans/api/templates/TemplateRegistration.java
@@ -147,7 +147,7 @@ public @interface TemplateRegistration {
String page() default "";
/** Selects some of provided technologies. The
- * <a href="http://bits.netbeans.org/html+java/">HTML/Java API</a>
+ * <a href="https://bits.netbeans.org/html+java/dev">HTML/Java API</a>
* provides support for technology ids since version 1.1.
* With this attribute one can specify the preferred technologies
* to use in this wizard as well.
diff --git a/platform/editor.mimelookup/arch.xml
b/platform/editor.mimelookup/arch.xml
index 0627c9131e..2bd3e3e8f7 100644
--- a/platform/editor.mimelookup/arch.xml
+++ b/platform/editor.mimelookup/arch.xml
@@ -184,7 +184,7 @@ There are several testing areas covered:
</ul>
-After fixing the <a
href="http://www.netbeans.org/issues/show_bug.cgi?id=58941"> issue #58941 </a>
+After fixing the <a
href="https://bz.apache.org/netbeans/show_bug.cgi?id=58941"> issue #58941 </a>
unit tests of template lookup should be added. All tests was rewritten and
adjusted to newly introduced
MimePath.
</answer>
diff --git
a/platform/editor.mimelookup/src/org/netbeans/api/editor/mimelookup/MimeLookup.java
b/platform/editor.mimelookup/src/org/netbeans/api/editor/mimelookup/MimeLookup.java
index 717158b4d9..8399185810 100644
---
a/platform/editor.mimelookup/src/org/netbeans/api/editor/mimelookup/MimeLookup.java
+++
b/platform/editor.mimelookup/src/org/netbeans/api/editor/mimelookup/MimeLookup.java
@@ -96,7 +96,7 @@ public final class MimeLookup extends Lookup {
* Gets a <code>Lookup</code> implementation that exposes objects specific
* for the given <code>MimePath</code> for the given mime-type
* or mime-path given as string.
- * <br/>
+ * <br>
* The method first translates the string mime-path into {@link MimePath}
* by using {@link MimePath#parse(String)} and then calls
* {@link #getLookup(MimePath)}.
diff --git
a/platform/editor.mimelookup/src/org/netbeans/api/editor/mimelookup/MimePath.java
b/platform/editor.mimelookup/src/org/netbeans/api/editor/mimelookup/MimePath.java
index 50f9598006..9cb0347ded 100644
---
a/platform/editor.mimelookup/src/org/netbeans/api/editor/mimelookup/MimePath.java
+++
b/platform/editor.mimelookup/src/org/netbeans/api/editor/mimelookup/MimePath.java
@@ -80,7 +80,7 @@ import org.openide.util.Lookup;
* contains several consecutive mime types that are the same.
*
* <p>The format of a valid mime type string is described in
- * <a href="http://tools.ietf.org/html/rfc4288#section-4.2">RFC 4288</a>.
+ * <a href="https://www.rfc-editor.org/rfc/rfc4288.html#section-4.2">RFC
4288</a>.
* <code>MimePath</code> performs internall checks according to this
specification.
*
* <p><b>Identity:</b> By definition two <code>MimePath</code> instances are
equal
@@ -98,7 +98,7 @@ import org.openide.util.Lookup;
*
* @author Miloslav Metelka, Vita Stejskal
* @see MimeLookup
- * @see <a href="http://tools.ietf.org/html/rfc4288#section-4.2">RFC 4288</a>
+ * @see <a href="https://www.rfc-editor.org/rfc/rfc4288.html#section-4.2">RFC
4288</a>
*/
public final class MimePath {
@@ -226,14 +226,14 @@ public final class MimePath {
* Validates components of a mime type. Each mime types is compound from
* two components - <i>type</i> and <i>subtype</i>. There are rules that
* both components must obey. For details see
- * <a href="http://tools.ietf.org/html/rfc4288#section-4.2">RFC 4288</a>.
+ * <a href="https://www.rfc-editor.org/rfc/rfc4288.html#section-4.2">RFC
4288</a>.
*
* @param type The type component of a mime type to validate. If
<code>null</code>
* the type component will not be validated.
* @param subtype The subtype component of a mime type to validate. If
<code>null</code>
* the subtype component will not be validated.
*
- * @return <code>true</code> if non-</code>null</code> components passed in
+ * @return <code>true</code> if non-<code>null</code> components passed in
* are valid mime type components, otherwise <code>false</code>.
* @since 1.7
*/
@@ -339,7 +339,7 @@ public final class MimePath {
/**
* Get string path represented by this mime-path.
- * <br/>
+ * <br>
* For example <code>"text/x-jsp/text/x-java"</code>.
*
* @return non-null string path.
@@ -370,7 +370,7 @@ public final class MimePath {
* <code>getMimeType(0)</code> returns <code>"text/x-jsp"</code>
* and <code>getMimeType(1)</code> returns <code>"text/x-java"</code>.
*
- * @param index >=0 && < {@link #size()}.
+ * @param index >=0 && < {@link #size()}.
* @return non-null mime-type at the given index.
* @throws IndexOutOfBoundsException in case the index is not within
* required bounds.
@@ -383,7 +383,7 @@ public final class MimePath {
* Return prefix mime-path with the given number of mime-type components
* ranging from zero till the size of this mime-path.
*
- * @param size >=0 && <= {@link #size()}.
+ * @param size >=0 && <= {@link #size()}.
* <br>
* For zero size the {@link #EMPTY} will be returned.
* <br>
@@ -524,7 +524,7 @@ public final class MimePath {
* For {@link #EMPTY}, returns {@code null}. For most other mime types,
returns
* {@code ""}. If the mime type derives from another one, such as
text/ant+xml derives
* from xml, the return value will be the base mime type (text/xml in the
example case).
- * <p/>
+ * <p>
* For MimePaths that identified embedded content (more components on the
MimePath),
* the method returns the parent MIME of the last MIME type on the path
*
@@ -555,7 +555,7 @@ public final class MimePath {
* <li>text/css -- the mime type of the identified content itself
* <li> (empty string)
* </ol>
- * <p/>
+ * <p>
* If a MIME type on the path has a generic MIME type (i.e. text/x-ant+xml
* has a generic MIME type text/xml), that generic type will be inserted.
For example,
* for text/java/text/x-ant+xml/text/javascript, the result will list:
@@ -569,17 +569,17 @@ public final class MimePath {
* For all but {@link #EMPTY} MimePaths, the list contains at least one
entry, and the last
* entry is the {@link #EMPTY}. Note also, that the complete MimePath is
always returned
* as the 1st member of the list.
- * <p/>
+ * <p>
* The returned sequence of MimePaths is suitable for searching settings
or services
* for the (embedded) content whose type is described by MimePath as it is
ordered from the
* most specific to the least specific paths (including generalization)
and always contains
- * the mime type of the identified contents. The last component ({@link
""}) represents
+ * the mime type of the identified contents. The last component ({@code
""}) represents
* default settings (services).
- * <p/>
+ * <p>
* Note that for MimePaths created from a mime type (not empty!) string,
the
* <code>getInheritedPaths().get(1)</code> is a parent mime type. Either
empty,
* or the generalized MIME.
- * <p/>
+ * <p>
* The caller should not modify the returned List.
*
* @return list of inherited Mime paths
diff --git
a/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/Class2LayerFolder.java
b/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/Class2LayerFolder.java
index f8858a1b67..79878a2075 100644
---
a/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/Class2LayerFolder.java
+++
b/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/Class2LayerFolder.java
@@ -36,7 +36,7 @@ package org.netbeans.spi.editor.mimelookup;
* path 'text/x-jsp/text/x-java' and they would be located in the folder
* 'Editors/text/x-jsp/text/x-java' on the system filesystem. For more details
* on the implementation of the default <code>MimeDataProvider</code> please
see
- * the <a href="package-summary.html#defaultMimeDataProvider"/>SPI package</a>
description.
+ * the <a href="package-summary.html#defaultMimeDataProvider">SPI package</a>
description.
*
* <p>The implementations of this interface are used for determining the
structure
* under the folder belonging to a given mime type. This interface allows to
@@ -51,7 +51,7 @@ package org.netbeans.spi.editor.mimelookup;
* can be registered in the 'Editors/text/x-java/foldManager' folder and they
* will be properly retrieved when calling
*
<code>MimeLookup.getLookup(MimePath.get("text/x-java")).lookup(FolderManager.class);</code>.
- * @param T type of instance which will be created
+ * @param <T> type of instance which will be created
*
* @author Miloslav Metelka, Martin Roskanin, Vita Stejskal
* @deprecated Use {@link MimeLocation} instead
diff --git
a/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/InstanceProvider.java
b/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/InstanceProvider.java
index 77b3c4f3f5..982a8c858c 100644
---
a/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/InstanceProvider.java
+++
b/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/InstanceProvider.java
@@ -32,10 +32,10 @@ import org.openide.filesystems.FileObject;
* For example there can be an instance provider
* of actions for the editor popup. The file object names
* of the actions declared in the layer can be of two forms:<ul>
- * <li><i>MyAction.instance</i> are actions instances declaration files</li>.
- * <li><i>reformat-code</i> are editor actions names</li>.
+ * <li><i>MyAction.instance</i> are actions instances declaration files.</li>
+ * <li><i>reformat-code</i> are editor actions names.</li>
* </ul>
- * <br/>
+ * <br>
* The instance provider translates all the file objects to actions
* which it returns as a collection in some sort of collection-like class
* e.g.<pre>
@@ -45,7 +45,7 @@ import org.openide.filesystems.FileObject;
*
* }</pre>
*
- * @param T type of instance which will be created
+ * @param <T> type of instance which will be created
*/
public interface InstanceProvider<T> {
diff --git
a/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/MimeLookupInitializer.java
b/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/MimeLookupInitializer.java
index 2f99b8d149..4da377dabc 100644
---
a/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/MimeLookupInitializer.java
+++
b/platform/editor.mimelookup/src/org/netbeans/spi/editor/mimelookup/MimeLookupInitializer.java
@@ -67,10 +67,10 @@ public interface MimeLookupInitializer {
*
* @param mimeType mime-type string representation e.g. "text/x-java"
* @return non-null lookup result of MimeLookupInitializer(s).
- * <br/>
+ * <br>
* Typically there should be just one child initializer although if there
* will be more than one all of them will be taken into consideration.
- * <br/>
+ * <br>
* If there will be no specific initializers for the particular mime-type
* then an empty result should be returned.
*/
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/AbstractFileSystem.java
b/platform/openide.filesystems/src/org/openide/filesystems/AbstractFileSystem.java
index 91bacdf22e..1609bf3313 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/AbstractFileSystem.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/AbstractFileSystem.java
@@ -206,7 +206,7 @@ public abstract class AbstractFileSystem extends FileSystem
{
/** Set the number of milliseconds between automatic
* refreshes of the directory structure.
*
- * @param ms number of milliseconds between two refreshes; if <code><=
0</code> then refreshing is disabled
+ * @param ms number of milliseconds between two refreshes; if <code><=
0</code> then refreshing is disabled
*/
protected final synchronized void setRefreshTime(int ms) {
if (refresher != null) {
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/DefaultAttributes.java
b/platform/openide.filesystems/src/org/openide/filesystems/DefaultAttributes.java
index 35def7c0c1..3b944cd36b 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/DefaultAttributes.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/DefaultAttributes.java
@@ -67,7 +67,8 @@ import org.xml.sax.helpers.DefaultHandler;
* (it can then serve to filter a plain list implementation).
*
*Description of format of special file ilustrates best DTD file that is
showed in next lines:
- *<!ELEMENT attributes (fileobject)*>
+ * <pre>{@code
+ * <!ELEMENT attributes (fileobject)*>
* <!ATTLIST attributes version CDATA #REQUIRED>
* <!ELEMENT fileobject (attr)*>
* <!ATTLIST fileobject name CDATA #REQUIRED>
@@ -85,7 +86,8 @@ import org.xml.sax.helpers.DefaultHandler;
* <!ATTLIST attr methodvalue CDATA #IMPLIED>
* <!ATTLIST attr serialvalue CDATA #IMPLIED>
* <!ATTLIST attr urlvalue CDATA #IMPLIED>
- *
+ * }
+ * </pre>
* @author Jaroslav Tulach
*/
@SuppressWarnings("unchecked")
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/FileEvent.java
b/platform/openide.filesystems/src/org/openide/filesystems/FileEvent.java
index f05615a28c..267703c46c 100644
--- a/platform/openide.filesystems/src/org/openide/filesystems/FileEvent.java
+++ b/platform/openide.filesystems/src/org/openide/filesystems/FileEvent.java
@@ -209,7 +209,7 @@ public class FileEvent extends EventObject {
* }
*
* <b>public boolean</b> equals(Object obj) {
- * <b>return</b> obj != null && obj.getClass() == {@link #getClass()};
+ * <b>return</b> obj != null && obj.getClass() == {@link
#getClass()};
* }
*
* <b>public int</b> hashCode() {
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/FileExtrasLkp.java
b/platform/openide.filesystems/src/org/openide/filesystems/FileExtrasLkp.java
index 86266b0003..bbc644766f 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/FileExtrasLkp.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/FileExtrasLkp.java
@@ -28,7 +28,7 @@ import org.openide.util.lookup.InstanceContent;
* Stub for backwards compatibility. The real implementation which bridges
* in system actions moved to openide.filesystems.compat8
*
- * @author Jaroslav Tulach <[email protected]>
+ * @author Jaroslav Tulach <[email protected]>
*/
final class FileExtrasLkp extends AbstractLookup {
final FileSystem fs;
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/FileLock.java
b/platform/openide.filesystems/src/org/openide/filesystems/FileLock.java
index 5f611f8b3c..a23d0deb7d 100644
--- a/platform/openide.filesystems/src/org/openide/filesystems/FileLock.java
+++ b/platform/openide.filesystems/src/org/openide/filesystems/FileLock.java
@@ -30,7 +30,7 @@ import java.util.logging.Level;
* Normally this is sufficient protection. If you really need an atomic read,
you may
* simply lock the file, perform the read, and unlock it when done. The file
will still
* be protected against writes, although the read operation did not request a
lock.
-* <p/>
+* <p>
* The {@code FileLock} implements {@link AutoCloseable}, so it can be created
within
* try-with-resources resource clause and the lock will be released at the end
of the try block.
*
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/FileObject.java
b/platform/openide.filesystems/src/org/openide/filesystems/FileObject.java
index 7587619039..8f014f0d70 100644
--- a/platform/openide.filesystems/src/org/openide/filesystems/FileObject.java
+++ b/platform/openide.filesystems/src/org/openide/filesystems/FileObject.java
@@ -198,7 +198,7 @@ public abstract class FileObject extends Object implements
Serializable, Lookup.
* <p>Subclasses are strongly encouraged to override this method.
* <p>Never use this to get a display name for the file! Use {@link
FileUtil#getFileDisplayName}.
* <p>Do not use this method to find a file path on disk! Use {@link
FileUtil#toFile}.
- * @return the path, for example <samp>path/from/root.ext</samp>
+ * @return the path, for example <code>path/from/root.ext</code>
* @see FileSystem#findResource
* @since 3.7
*/
@@ -211,8 +211,8 @@ public abstract class FileObject extends Object implements
Serializable, Lookup.
/** Get fully-qualified filename. Does so by walking through all folders
* to the root of the filesystem. Separates files with provided
<code>separatorChar</code>.
* The extension, if present, is separated from the basename with
<code>extSepChar</code>.
- * <p><strong>Note:</strong> <samp>fo.getPath()</samp> will have the
- * same effect as using this method with <samp>/</samp> and <samp>.</samp>
(the standard
+ * <p><strong>Note:</strong> <code>fo.getPath()</code> will have the
+ * same effect as using this method with <code>/</code> and <code>.</code>
(the standard
* path and extension delimiters).
* @param separatorChar char to separate folders and files
* @param extSepChar char to separate extension
@@ -451,7 +451,6 @@ public abstract class FileObject extends Object implements
Serializable, Lookup.
* this method is implementation dependent. It is generally expected that
* the attribute will later be available from {@link
#getAttribute(java.lang.String)}
* method.
- * <p>
* <div class="nonnormative">
* Many <a
href="@TOP@/org/openide/filesystems/FileSystem.html">FileSystem</a>
* implementations (since version 7.43)
@@ -1061,7 +1060,7 @@ public abstract class FileObject extends Object
implements Serializable, Lookup.
* events. Preferably it delivers them asynchronously. The assumption
* is that the file will be (at least partially) written before
* the listeners start to process the first event. The safety is
additionally
- * ensured by <q>mutual exclusion</q> between output and input streams
+ * ensured by <em>mutual exclusion</em> between output and input streams
* for the same file (any call to {@link #getInputStream()} will be blocked
* for at least two seconds if there is existing open output stream).
* If you finish writing the content of your file in those two seconds,
@@ -1122,7 +1121,7 @@ public abstract class FileObject extends Object
implements Serializable, Lookup.
* <ul>
* <li>If no exception is thrown, proceed with the operation.
* <li>If a UserQuestionException is thrown,
- * call {@link UserQuestionException#confirmed} on it
+ * call <a
href="@org-openide-util-ui@/org/openide/util/UserQuestionException.html#confirmed--"
>UserQuestionException#confirmed</a> on it
* (asynchronously - do not block any important threads). If
<code>true</code>,
* proceed with the operation. If <code>false</code>, exit.
* If an <code>IOException</code> is thrown, notify it and exit.
@@ -1198,7 +1197,7 @@ public abstract class FileObject extends Object
implements Serializable, Lookup.
* Note that while content can be reset, it may not be possible to reset
attributes.
* <p>Implementors: for historical reasons this method checks {@link
#getAttribute}
* for a special attribute named {@code removeWritables} which must be of
type
- * {@link Callable Callable<Void>}. If present, the file is considered
modified.
+ * {@link Callable Callable<Void>}. If present, the file is
considered modified.
* @since 7.55
*/
public final void revert() throws IOException {
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/FileSystem.java
b/platform/openide.filesystems/src/org/openide/filesystems/FileSystem.java
index 5f76d83500..bb9bd0ec15 100644
--- a/platform/openide.filesystems/src/org/openide/filesystems/FileSystem.java
+++ b/platform/openide.filesystems/src/org/openide/filesystems/FileSystem.java
@@ -455,13 +455,13 @@ public abstract class FileSystem implements Serializable {
* will be honored as of org.openide.filesystems 7.25:
* <dl>
* <dt>{@code displayName}</dt>
- * <dd>Value of {@link Status#annotateName}. Often used with {@code
bundlevalue} in an {@link XMLFileSystem}.</dd>
+ * <dd>Value of <a
href="https://github.com/apache/netbeans/tree/master/platform/openide.filesystems.nb/src/org/netbeans/modules/openide/filesystems/FileSystemStatus.java">FileSystemStatus#annotateName</a>.
Often used with {@code bundlevalue} in an {@link XMLFileSystem}.</dd>
* <dt>{@code SystemFileSystem.localizingBundle}</dt>
* <dd>Name of a bundle (as per {@link NbBundle#getBundle(String)}) in
which to look up a display name.
* The bundle key is the {@link FileObject#getPath}.
* {@code displayName} is preferred for new code.</dd>
* <dt>{@code iconBase}</dt>
- * <dd>Resource path to icon for {@link Status#annotateIcon}.
+ * <dd>Resource path to icon for <a
href="https://github.com/apache/netbeans/tree/master/platform/openide.filesystems.nb/src/org/netbeans/modules/openide/filesystems/FileSystemStatus.java">FileSystemStatus#annotateIcon</a>.
* {@code _32} will be inserted before the file suffix for 32x32
icons.</dd>
* <dt>{@code SystemFileSystem.icon} and {@code
SystemFileSystem.icon32}</dt>
* <dd>Icon specified directly as a {@link URL} (usually {@code nbresloc}
protocol)
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/FileUtil.java
b/platform/openide.filesystems/src/org/openide/filesystems/FileUtil.java
index 3151748d88..7c0d6eafe5 100644
--- a/platform/openide.filesystems/src/org/openide/filesystems/FileUtil.java
+++ b/platform/openide.filesystems/src/org/openide/filesystems/FileUtil.java
@@ -247,7 +247,7 @@ public final class FileUtil extends Object {
/**
* Adds a listener to changes in a given path. It permits you to listen to
a file
* which does not yet exist, or continue listening to it after it is
deleted and recreated, etc.
- * <br/>
+ * <br>
* When given path represents a file ({@code path.isDirectory() == false})
* <ul>
* <li>fileDataCreated event is fired when the file is created</li>
@@ -323,7 +323,7 @@ public final class FileUtil extends Object {
/**
* Adds a listener to changes under given path. It permits you to listen
to a file
* which does not yet exist, or continue listening to it after it is
deleted and recreated, etc.
- * <br/>
+ * <br>
* When given path represents a file ({@code path.isDirectory() ==
false}), this
* code behaves exactly like {@link
#addFileChangeListener(org.openide.filesystems.FileChangeListener,
java.io.File)}.
* Usually the path shall represent a folder ({@code path.isDirectory() ==
true})
@@ -1070,7 +1070,7 @@ public final class FileUtil extends Object {
* @param is input stream of jar file
* @exception IOException if the extraction fails
* @deprecated Use of XML filesystem layers generally obsoletes this method.
- * For tests, use {@link
org.openide.util.test.TestFileUtils#unpackZipFile}.
+ * For tests, use {@code
org.openide.util.test.TestFileUtils#unpackZipFile}.
*/
@Deprecated
public static void extractJar(final FileObject fo, final InputStream is)
@@ -2059,7 +2059,7 @@ public final class FileUtil extends Object {
* If the file looks to represent a directory, a <code>file</code> URL
will be created.
* If it looks to represent a ZIP archive, a <code>jar</code> URL will be
created.
* @param entry a file or directory name
- * @return an appropriate classpath URL which will always end in a slash
(<samp>/</samp>),
+ * @return an appropriate classpath URL which will always end in a slash
(<code>/</code>),
* or null for an existing file which does not look like a valid
archive
* @since org.openide.filesystems 7.8
*/
@@ -2133,7 +2133,7 @@ public final class FileUtil extends Object {
* @param chooser a file chooser
* @param currentDirectory if not null, a file to set as the current
directory
* using {@link
javax.swing.JFileChooser#setCurrentDirectory} without canonicalizing
- * @see <a
href="http://www.netbeans.org/issues/show_bug.cgi?id=46459">Issue #46459</a>
+ * @see <a
href="https://bz.apache.org/netbeans/show_bug.cgi?id=46459">Issue #46459</a>
* @see <a
href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4906607">JRE bug
#4906607</a>
* @since org.openide/1 4.42
* @deprecated Just use {@link
javax.swing.JFileChooser#setCurrentDirectory}. JDK 6 does not have this bug.
@@ -2159,7 +2159,7 @@ public final class FileUtil extends Object {
* @throws IllegalArgumentException in case there are duplicates, or
nulls, or the files do not have a common parent
* @since org.openide.filesystems 7.2
* @see #setOrder
- * @see <a
href="http://wiki.netbeans.org/wiki/view/FolderOrdering103187">Specification</a>
+ * @see <a
href="https://netbeans.apache.org/wiki/FolderOrdering103187">Specification</a>
*/
public static List<FileObject> getOrder(Collection<FileObject> children,
boolean logWarnings) throws IllegalArgumentException {
return Ordering.getOrder(children, logWarnings);
@@ -2197,7 +2197,7 @@ public final class FileUtil extends Object {
* If you wish to create the file/folder when it does not already exist,
* start with {@link #getConfigRoot} and use {@link
#createData(FileObject, String)}
* or {@link #createFolder(FileObject, String)} methods.
- * <p/>
+ * <p>
* In environment with multiple contextual Lookups, the method may return
different FileObject depending
* on what Lookup serves the executing thread. If the system-wide
(user-independent) configuration
* is required instead, {@link #getSystemConfigFile} should be called
instead. If an service instance is created based
@@ -2227,7 +2227,7 @@ public final class FileUtil extends Object {
* Because default/config filesystem is used both for configuration and
services, Lookup or service providers
* should use this method in preference to {@link #getConfigFile} to
produce singleton services even
* in multiple context environment.
- * <p/>
+ * <p>
* With the default Lookup implementation, behaviour of {@code
getSystemConfigFile} and {@link #getConfigFile}
* is identical.
*
@@ -2250,7 +2250,7 @@ public final class FileUtil extends Object {
* Actions/Edit/org-openide-actions-CopyAction.instance
* Services/Browsers/swing-browser.settings
* </pre>
- * <p/>
+ * <p>
* In multi-user setup, this method returns instance specific for the
executing user.
* <b>Important</b>: it returns user-specific instance even though the
object is configured in
* a XML layer, or system-wide configuration; still, the instance will be
tied to the user-specific
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/MIMEResolver.java
b/platform/openide.filesystems/src/org/openide/filesystems/MIMEResolver.java
index 3bf2d172e5..5de1362a41 100644
--- a/platform/openide.filesystems/src/org/openide/filesystems/MIMEResolver.java
+++ b/platform/openide.filesystems/src/org/openide/filesystems/MIMEResolver.java
@@ -187,14 +187,14 @@ public abstract class MIMEResolver {
*/
public String[] extension();
/** In case ordering of mime resolvers is important, one can
- * specify it by defining their {@link LayerBuilder#position()
position}.
+ * specify it by defining their {@link
org.openide.filesystems.annotations.LayerBuilder.File#position(int) position}.
*/
public int position() default Integer.MAX_VALUE;
/**
* Show file filters for this MIME type. Set localized names of file
* filters that should contain files resolved by this resolver.
*
- * @see FileChooserBuilder#addDefaultFileFilters()
+ * @see <a
href="@org-openide-filesystems-nb@/org/openide/filesystems/FileChooserBuilder.html#addDefaultFileFilters--"
>FileChooserBuilder#addDefaultFileFilters()</a>
* @since 8.1
*/
public String[] showInFileChooser() default {};
@@ -242,7 +242,7 @@ public abstract class MIMEResolver {
*/
public String mimeType();
/** In case ordering of mime resolvers is important, one can
- * specify it by defining their {@link LayerBuilder#position()
position}.
+ * specify it by defining their {@link
org.openide.filesystems.annotations.LayerBuilder.File#position(int) position}.
*/
public int position() default Integer.MAX_VALUE;
@@ -289,7 +289,7 @@ public abstract class MIMEResolver {
* an XML like <a href="doc-files/HOWTO-MIME.html">document</a> describing
* the rules that will be interpreted by the mime recognizing
infrastructure.
* <pre>
- * {@code @}{@link NbBundle.Messages}({
+ * {@code @}{@link org.openide.util.NbBundle.Messages}({
* "NICE_NAME=Nice name!"
* })
* {@code @}MIMEResolver.Registration(
@@ -314,7 +314,7 @@ public abstract class MIMEResolver {
public String resource();
/** In case ordering of mime resolvers is important, one can
- * specify it by defining their {@link LayerBuilder#position()
position}.
+ * specify it by defining their {@link
org.openide.filesystems.annotations.LayerBuilder.File#position(int) position}.
*/
public int position() default Integer.MAX_VALUE;
@@ -327,7 +327,7 @@ public abstract class MIMEResolver {
* types resolved by file name or extension (not by file content) are
* supported.
*
- * @see FileChooserBuilder#addDefaultFileFilters()
+ * @see <a
href="@org-openide-filesystems-nb@/org/openide/filesystems/FileChooserBuilder.html#addDefaultFileFilters--"
>FileChooserBuilder#addDefaultFileFilters()</a>
* @since 8.1
*/
public String[] showInFileChooser() default {};
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/MultiFileSystem.java
b/platform/openide.filesystems/src/org/openide/filesystems/MultiFileSystem.java
index baae86712d..6b5122eb81 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/MultiFileSystem.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/MultiFileSystem.java
@@ -86,8 +86,8 @@ import org.openide.util.NbCollections;
* is deleted? There must be a way to indicate on the foremost delegate that
it should not appear in the
* composite (even while it remains in one of the delegates). For this reason,
<code>MultiFileSystem</code> uses
* "masks" which are simply empty files named according to the file they
should hide, but with the suffix
- * <samp>_hidden</samp>. Thus, for example, if there is a file
<samp>subdir/readme.txt_hidden</samp> in a front
- * delegate it will hide any files named <samp>subdir/readme.txt</samp> in
delegates further back. These masks
+ * <code>_hidden</code>. Thus, for example, if there is a file
<code>subdir/readme.txt_hidden</code> in a front
+ * delegate it will hide any files named <code>subdir/readme.txt</code> in
delegates further back. These masks
* are automatically created as needed when files are "deleted" from
<code>MultiFileSystem</code>; or delegate
* filesystems may explicitly provide them. Normally the mask files are not
themselves visible as {@link
* FileObject}s, since they are an artifact of the deletion logic. However,
when nesting
@@ -105,7 +105,6 @@ import org.openide.util.NbCollections;
* returned from the MFS, if they exist. The FileObjects can be also casted to
<code>Callable<FileObject></code>. When
* called, the original version of the file is restored on the
MultiFileSystem, and the restored instance is returned
* as result.
- * <p>
*/
public class MultiFileSystem extends FileSystem {
static final long serialVersionUID = -767493828111559560L;
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/Repository.java
b/platform/openide.filesystems/src/org/openide/filesystems/Repository.java
index 47f592fe3d..30ab804330 100644
--- a/platform/openide.filesystems/src/org/openide/filesystems/Repository.java
+++ b/platform/openide.filesystems/src/org/openide/filesystems/Repository.java
@@ -119,7 +119,7 @@ public class Repository implements Serializable {
*/
protected abstract void registerLayers(Collection<? super URL>
context);
- /** Method to call when set of URLs returned from the {@link #layers()}
+ /** Method to call when set of URLs returned from the {@link
#registerLayers(java.util.Collection)}
* method changed and there is a need to refresh it. Refresh is very
likely
* a time consuming task - consider invoking it on a background thread
and
* don't hold any locks while calling the method
@@ -334,13 +334,13 @@ public class Repository implements Serializable {
* The instance is either taken as a result of
* <CODE>org.openide.util.Lookup.getDefault ().lookup
(Repository.class)</CODE>
* or (if the lookup query returns null) a default instance is created.
- * <p/>
+ * <p>
* In a contextual environment, the method remembers the result of the
default Lookup
* query, and will return the same instance as a system-wide Repository
instance.
* Instances provided by
<code>Lookup.getDefault().lookup(Repository.class)</code> may vary
* depending on the Lookup's implementation and context - be aware that
multiple Repository
* instances may exist, possibly one for each contextual Lookup craeted.
- * <p/>
+ * <p>
*
* @return default repository for the system
* @since 9.5 support for multiple contexts
@@ -396,7 +396,7 @@ public class Repository implements Serializable {
* existing ADD_FS value. In fact, the Repository instance <b>is usually
instantiated twice</b>,
* because ctor initialization indirectly invokes Repository.getDefault(),
resulting in another
* initialization.
- * <p/>
+ * <p>
* <b>Performance note:</b> during startup, the default Lookup changes
frequently because of modules
* activations. The <code>lkp.lookup(LocalProvider.class)</code> query
blocks on Lookup computation
* locks, adding up to 20% to startup time. The last discovered value of
LocalProvider is therefore cached
@@ -404,7 +404,7 @@ public class Repository implements Serializable {
* If {@code getLocalRepository} is called again with the default Lookup
instance unchanged (= the same execution context),
* no {@code lookup()} query will be executed and the cached {@code
LocalProvider} instance will be
* used to return the repository instance.
- * <p/>
+ * <p>
* In multi-user/execution environment, this cache is beneficial during
system startup; after that, the
* default Lookup changes with the execution context frequently, but
contents of individual Lookups are rather
* stable, so performance should be acceptable.
@@ -1025,12 +1025,11 @@ public class Repository implements Serializable {
/**
* Provides local repositories, depending on the current execution
environment.
- * The caller may use {@link Lookup#executeWith} to temporarily modify the
default
+ * The caller may use {@link
org.openide.util.lookup.Lookups#executeWith(org.openide.util.Lookup,
java.lang.Runnable)} to temporarily modify the default
* Lookup contents and route Repository requests to a Repository private
to some task. The
* {@code LocalProvider} is responsible for caching and lifecycle of the
Repository instance;
* it can expire the Repository if the Provider's execution context
terminates. Implementations
* must be prepared to handle requests for Repository already shutdown etc.
- * <p/>
* @since 9.5
*/
public abstract static class LocalProvider {
@@ -1040,7 +1039,7 @@ public class Repository implements Serializable {
* of Repository for the whole duration of the execution context. It
must return the same
* Repository instance even after the execution context shuts down;
the contents of Repository and
* its FileSystems may be limited in that case.
- * <p/>
+ * <p>
* Implementations must be reentrant (a call to {@link
#getLocalRepository} can be made during
* construction of the Repository instance) and must not recurse
infinitely.
*
@@ -1053,7 +1052,7 @@ public class Repository implements Serializable {
* constructor still takes the default FileSystem instance. However it
is better to actually publish the
* FileSystem in the repository only after it is registered, and can
be obtained using {@link #getDefault()} or
* {@link #getLocalRepository()}.
- * <p/>
+ * <p>
* This method wraps the Repository creation so that the default
FileSystem is attached after the repository
* is fully constructed. The `init' callable must create a new
Repository instance.
* This method will then add the default FS for newly created
repository instances.
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/StatusDecorator.java
b/platform/openide.filesystems/src/org/openide/filesystems/StatusDecorator.java
index 7a3ac2006d..8948ba29c6 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/StatusDecorator.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/StatusDecorator.java
@@ -23,14 +23,14 @@ import java.util.Set;
/**
* Provides decorations based on file state.
* Allows a filesystem to annotate a group of files with additional markers.
- * <p/>
+ * <p>
* This could be useful, for example, for a filesystem supporting version
* control. It could annotate names and icons of data nodes according to
whether
* the files were current, locked, etc.
- * <p/>
+ * <p>
* Textual and HTML markup annotations are supported. The implementation must
* support at least plain annotation.
- * <p/>
+ * <p>
* This interface replaces and supersedes the former {@code
FileSystem.Status}.
* Other markers are possible, e.g. icon, but they are not provided in this
interface.
* For icon or other GUI artifacts, please see {@code openide.filesystems.nb}
module,
@@ -61,7 +61,7 @@ public interface StatusDecorator {
* filesystems that proxy other filesystems (and so must implement
* this interface to supply HTML annotations) should return null if
* the filesystem they proxy does not provide an implementation of
- * {@link FileSystem.HtmlStatus}.
+ * {@code FileSystem.HtmlStatus}.
* <p>Note that since the {@code name} argument must be free of HTML,
* it is tricky to use this decorator on a {@code Node} arising from
* foreign code, to chain decorators, or otherwise when you wish to add
@@ -82,8 +82,8 @@ public interface StatusDecorator {
* HtmlStatus but plain Status.
*
* @since FileSystems API, 4.30
- * @see <a
href="@org-openide-loaders@/org/openide/loaders/DataNode.html#getHtmlDisplayName()"><code>DataNode.getHtmlDisplayName()</code></a>
- * @see <a
href="@org-openide-nodes@/org/openide/nodes/Node.html#getHtmlDisplayName"><code>Node.getHtmlDisplayName()</code></a>
+ * @see <a
href="@org-openide-loaders@/org/openide/loaders/DataNode.html#getHtmlDisplayName--"><code>DataNode.getHtmlDisplayName()</code></a>
+ * @see <a
href="@org-openide-nodes@/org/openide/nodes/Node.html#getHtmlDisplayName--"><code>Node.getHtmlDisplayName()</code></a>
**/
public String annotateNameHtml(String name, Set<? extends FileObject>
files);
}
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/URLMapper.java
b/platform/openide.filesystems/src/org/openide/filesystems/URLMapper.java
index d295a4d535..644e8a4e3a 100644
--- a/platform/openide.filesystems/src/org/openide/filesystems/URLMapper.java
+++ b/platform/openide.filesystems/src/org/openide/filesystems/URLMapper.java
@@ -64,7 +64,7 @@ public abstract class URLMapper {
* Not guaranteed to work from other machines (though it may).
* <div class="nonnormative">
* Typical protocols used: <code>file</code> for disk files (see {@link
File#toURI});
- * <code>jar</code> to wrap other URLs (e.g.
<samp>jar:file:/some/thing.jar!/some/entry</samp>).
+ * <code>jar</code> to wrap other URLs (e.g.
<code>jar:file:/some/thing.jar!/some/entry</code>).
* </div>
*/
public static final int EXTERNAL = 1;
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/XMLFileSystem.java
b/platform/openide.filesystems/src/org/openide/filesystems/XMLFileSystem.java
index bf1d9e6dc9..124b8649d4 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/XMLFileSystem.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/XMLFileSystem.java
@@ -120,12 +120,12 @@ import org.xml.sax.helpers.DefaultHandler;
* or two arguments. This method does not need to be public or in public
class, if
* the filesystem has permissions to call the method. The method can take one
* of the following signatures:
- * <pre>
+ * <pre>{@code
* static Value methodName();
* static Value methodName(FileObject fo);
* static Value methodName(FileObject fo, String attrName);
* static Value methodName(Map<String,Object> attrs); // since 7.0
- * static Value methodName(Map<String,Object> attrs, String attrName); //
since 7.0
+ * static Value methodName(Map<String,Object> attrs, String attrName); //
since 7.0}
* </pre>
* where <code>Value</code> can be any java type.
* <p>
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/annotations/package-info.java
b/platform/openide.filesystems/src/org/openide/filesystems/annotations/package-info.java
index 4fc18878ed..c7f1dde476 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/annotations/package-info.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/annotations/package-info.java
@@ -29,7 +29,7 @@
* declare that a frobnitz factory should be located in the system filesystem
* in the folder {@code FrobnitzFactories/mime/type/} where {@code mime/type}
is
* the associated data type, and should be declared as an instance file whose
instance
- * is assignable to {@code FrobnitzFactory} (basename of file irrelevant).<p>
+ * is assignable to {@code FrobnitzFactory} (basename of file irrelevant).
* <p>(The SPI could also have just declared a global service interface where
each
* instance specifies its desired MIME type in the return value of a method.
This
* would work but would be undesirable from a performance perspective: the
first
@@ -40,7 +40,7 @@
* module developers can do the right thing without much effort.)</p>
* <p>The SPI may also stipulate that for a given data type, it may matter
which
* factory is found "first". SPI code to handle the factories might look
like:</p>
- * <pre>
+ * <pre>{@code
static Frobnitz findFrobnitz(FileObject f) {
for (FrobnitzFactory ff : Lookups.forPath("FrobnitzFactories/" +
f.getMIMEType()).
lookup(FrobnitzFactory.class).allInstances()) {
@@ -51,7 +51,7 @@ static Frobnitz findFrobnitz(FileObject f) {
}
return null;
}
- * </pre>
+ * }</pre>
* <p>There should then be an interface with a corresponding annotation:</p>
* <pre>
public interface FrobnitzFactory {
@@ -105,17 +105,17 @@ public class FrobnitzFactoryProcessor extends
LayerGeneratingProcessor {
* <p>Now when the module is compiled, {@code
build/classes/META-INF/generated-layer.xml}
* should look something like this:</p>
* <pre>
-<filesystem>
- <folder name="FrobnitzFactories">
- <folder name="text">
- <folder name="html">
- <file name="my-module-HtmlFactory.instance">
- <attr name="position" intvalue="300"/>
- </file>
- </folder>
- </folder>
- </folder>
-</filesystem>
+<filesystem>
+ <folder name="FrobnitzFactories">
+ <folder name="text">
+ <folder name="html">
+ <file name="my-module-HtmlFactory.instance">>
+ <attr name="position" intvalue="300"/>
+ </file>
+ </folder>
+ </folder>
+ </folder>>
+</filesystem>
* </pre>
* <p>and this layer should be loaded automatically by the module system
* (in addition to any explicit layer specified in source code).</p>
@@ -128,7 +128,7 @@ public class FrobnitzFactoryProcessor extends
LayerGeneratingProcessor {
* confirming that it succeeds or aborts under the right conditions.
* For this, <code>AnnotationProcessorTestUtils</code> is useful.</li>
* </ol>
- * <p><a
href="http://hg.netbeans.org/main/raw-file/tip/openide.util/test/unit/src/org/netbeans/modules/openide/util/ServiceProviderProcessorTest.java"><code>ServiceProviderProcessorTest</code></a>
- * demonstrates both styles.<p>
+ * <p><a
href="https://github.com/apache/netbeans/tree/master/platform/openide.util.lookup/test/unit/src/org/netbeans/modules/openide/util/ServiceProviderProcessorTest.java"><code>ServiceProviderProcessorTest</code></a>
+ * demonstrates both styles.
*/
package org.openide.filesystems.annotations;
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/doc-files/HOWTO-MIME.html
b/platform/openide.filesystems/src/org/openide/filesystems/doc-files/HOWTO-MIME.html
index 96c43d7d52..0b82521b94 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/doc-files/HOWTO-MIME.html
+++
b/platform/openide.filesystems/src/org/openide/filesystems/doc-files/HOWTO-MIME.html
@@ -155,7 +155,7 @@ annotation. It allows to specify nice display name and
position among other reso
folder.
<p>
- Note that an <a
href="http://deadlock.netbeans.org/job/nbms-and-javadoc/lastSuccessfulBuild/artifact/nbbuild/build/generated/layers.txt">open
position</a>
+ Note that an <a
href="https://ci-builds.apache.org/job/Netbeans/job/netbeans-linux/lastSuccessfulBuild/artifact/nbbuild/build/generated/layers.txt">open
position</a>
in the system filesystem should be specified.
Smaller positions mean the resolver runs earlier, which is appropriate for
commonly used file types, or resolvers which logically must take precedence
@@ -163,7 +163,7 @@ folder.
</p>
<h2>Links</h2>
-<a href="http://www.ietf.org/rfc/rfc3023.txt">RFC 3023: XML Media Types</a>
+<a href="https://www.ietf.org/rfc/rfc3023.txt">RFC 3023: XML Media Types</a>
<hr>@FOOTER@
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/spi/ArchiveRootProvider.java
b/platform/openide.filesystems/src/org/openide/filesystems/spi/ArchiveRootProvider.java
index 27350a108f..0588bb8b62 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/spi/ArchiveRootProvider.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/spi/ArchiveRootProvider.java
@@ -25,8 +25,8 @@ import org.openide.filesystems.URLMapper;
/**
* A possibility to plug a support for java archives into FileUtil.
- * The interface is used by {@link FileUtil.isArchiveArtifact}, {@link
FileUtil.isArchiveFile},
- * {@link FileUtil.getArchiveRoot}, {@link FileUtil.getArchiveFile}.
+ * The interface is used by {@link FileUtil#isArchiveArtifact}, {@link
FileUtil#isArchiveFile},
+ * {@link FileUtil#getArchiveRoot}, {@link FileUtil#getArchiveFile}.
* The implementations are registered in global lookup.
* @author Tomas Zezula
* @since 9.10
@@ -107,7 +107,7 @@ public interface ArchiveRootProvider {
/**
* Returns an URL representing the root of an archive.
- * Clients may need to first call {@link #isArchiveFile(URL)} to determine
if the URL
+ * Clients may need to first call {@link #isArchiveFile(URL,boolean)} to
determine if the URL
* refers to an archive file.
* @param url of an java archive file
* @return the archive-protocol URL of the root of the archive
@@ -116,7 +116,7 @@ public interface ArchiveRootProvider {
/**
* Returns a FileObject representing the root folder of an archive.
- * Clients may need to first call {@link #isArchiveFile(FileObject)} to
determine
+ * Clients may need to first call {@link
#isArchiveFile(FileObject,boolean)} to determine
* if the file object refers to an archive file.
* The default implementation delegates to {@link
ArchiveRootProvider#getArchiveRoot(URL)},
* it can be overridden by an implementation in more efficient way.
diff --git
a/platform/openide.filesystems/src/org/openide/filesystems/spi/CustomInstanceFactory.java
b/platform/openide.filesystems/src/org/openide/filesystems/spi/CustomInstanceFactory.java
index 9dd416b91d..37175b6a6b 100644
---
a/platform/openide.filesystems/src/org/openide/filesystems/spi/CustomInstanceFactory.java
+++
b/platform/openide.filesystems/src/org/openide/filesystems/spi/CustomInstanceFactory.java
@@ -23,13 +23,13 @@ package org.openide.filesystems.spi;
* Creates instance of the desired class based on the file.
* Module providers may register factories to control creation of instances
* from files that use only file name or {@code instanceClass} attribute.
- * <p/>
+ * <p>
* Registered factories are called in the registration order, until one
provides
* a non-null result, which become the file's created instance. If all
factories
* return {@code null}, the FileSystems API will create the instance using the
default
* constructor.
*
- * <p/>
+ * <p>
* Module implementors are encouraged to use the <code>instanceCreate</code>
attribute
* instead.
*
diff --git a/platform/openide.util.ui/arch.xml
b/platform/openide.util.ui/arch.xml
index dc9e95d87b..3a7a47a63b 100644
--- a/platform/openide.util.ui/arch.xml
+++ b/platform/openide.util.ui/arch.xml
@@ -43,7 +43,7 @@
<answer id="arch-quality">
<p>
There is a lot of unit tests in
- <a
href="http://hg.netbeans.org/main-golden/openide.util/test/unit/src/">version
control</a>
+ <a
href="https://github.com/apache/netbeans/tree/master/platform/openide.util/test/unit/src/">version
control</a>
system.
</p>
</answer>
@@ -118,15 +118,15 @@
This module is independent of other NetBeans modules and can be used
independently. For better interaction with UI parts of NetBeans it however
indirectly communicates with <a
href="@org-openide-awt@/overview-summary.html">UI Utilities</a>
- module using <api name="AWTBridge" category="private" group="java"
type="export"
-
url="http://www.netbeans.org/source/browse/openide/util/src/org/netbeans/modules/openide/util/AWTBridge.java">
+ module using <api name="DefaultAWTBridge" category="private" group="java"
type="export"
+
url="https://github.com/apache/netbeans/tree/master/platform/openide.awt/src/org/netbeans/modules/openide/awt/DefaultAWTBridge.java">
a class that is looked up in <a
href="@org-openide-util-lookup@/org/openide/util/Lookup.html#getDefault--">Lookup.getDefault()</a>
and if registered can provide better UI elements for <a
href="@JDK@/javax/swing/Action.html">Action</a>s.
</api>
</p>
<p>Support for SVG image loading can be enabled by including the optional
- <a href="@org-openide-util-ui-svg@/overview-summary.html">SVG Loader</a>
module.
+ <!-- <a href="@org-openide-util-ui-svg@/overview-summary.html"> --> SVG
Loader <!-- </a> --> module.
</p>
</answer>
@@ -277,7 +277,7 @@
for java beans introspection. <api category="private" group="java"
name="ParserFactory" type="import" >
The <a
href="@org-openide-util@/org/openide/xml/XMLUtil.html">XMLUtil</a> class is
loading
a class from <code>core/core.jar</code> to initialize the correct
parser factory.
- This is a fix for <a
href="http://www.netbeans.org/issues/show_bug.cgi?id=68942">issue 68942</a>.
+ This is a fix for <a
href="https://bz.apache.org/netbeans/show_bug.cgi?id=68942">issue 68942</a>.
</api>
</p>
</answer>
diff --git a/platform/openide.util.ui/src/org/openide/ErrorManager.java
b/platform/openide.util.ui/src/org/openide/ErrorManager.java
index ec8a7beb3f..55ab18208c 100644
--- a/platform/openide.util.ui/src/org/openide/ErrorManager.java
+++ b/platform/openide.util.ui/src/org/openide/ErrorManager.java
@@ -63,7 +63,6 @@ import org.openide.util.WeakSet;
* <li>INFORMATIONAL
* <li>UNKNOWN (lowest value)
* </ul>
- * </p>
*
* <div class="nonnormative">
* <p>How to...</p>
@@ -188,7 +187,7 @@ import org.openide.util.WeakSet;
* throw all;
* }
* </pre>
- * <dd>
+ *
*
* <dt>Logging a warning message just simply uses the JDK's logging API</dt>
* <dd>
@@ -405,7 +404,7 @@ public abstract class ErrorManager extends Object {
* the logging level for error managers of different names. For example,
in the basic
* NetBeans core implementation, you can define a system property with the
same name
* as the future error manager (or a package prefix of it) whose value is
the numeric
- * logging level (e.g.
<samp>-J-Dorg.netbeans.modules.mymodule.ComplicatedParser=0</samp>
+ * logging level (e.g.
<code>-J-Dorg.netbeans.modules.mymodule.ComplicatedParser=0</code>
* to log everything). Other implementations may have quite different ways
of configuring
* the error managers.
* @param name the desired identifying name
diff --git a/platform/openide.util.ui/src/org/openide/util/ImageUtilities.java
b/platform/openide.util.ui/src/org/openide/util/ImageUtilities.java
index 121738b316..f25db81bfd 100644
--- a/platform/openide.util.ui/src/org/openide/util/ImageUtilities.java
+++ b/platform/openide.util.ui/src/org/openide/util/ImageUtilities.java
@@ -185,9 +185,9 @@ public final class ImageUtilities {
/**
* Loads an image based on resource path.
* Exactly like {@link #loadImage(String)} but may do a localized search.
- * For example, requesting
<samp>org/netbeans/modules/foo/resources/foo.gif</samp>
- * might actually find
<samp>org/netbeans/modules/foo/resources/foo_ja.gif</samp>
- * or <samp>org/netbeans/modules/foo/resources/foo_mybranding.gif</samp>.
+ * For example, requesting
<code>org/netbeans/modules/foo/resources/foo.gif</code>
+ * might actually find
<code>org/netbeans/modules/foo/resources/foo_ja.gif</code>
+ * or <code>org/netbeans/modules/foo/resources/foo_mybranding.gif</code>.
*
* <p>Caching of loaded images can be used internally to improve
performance.
* <p> Since version 8.12 the returned image object responds to call
@@ -496,7 +496,7 @@ public final class ImageUtilities {
*/
private static SVGLoader getSVGLoader() {
/* "Objects contained in the default lookup are instantiated lazily
when first requested."
- ( http://wiki.netbeans.org/DevFaqLookupDefault ) So the SVGLoader
implementation module will
+ ( https://netbeans.apache.org/wiki/DevFaqLookupDefault ) So the
SVGLoader implementation module will
only be loaded the first time an SVG file is actually encountered for
loading, rather than,
for instance, when the startup splash screen initializes
ImageUtilities to load its PNG
image. This was confirmed by printing a debugging message from a
static initializer in
diff --git a/platform/openide.util.ui/src/org/openide/util/Utilities.java
b/platform/openide.util.ui/src/org/openide/util/Utilities.java
index 4c632f5d7c..deaae3f765 100644
--- a/platform/openide.util.ui/src/org/openide/util/Utilities.java
+++ b/platform/openide.util.ui/src/org/openide/util/Utilities.java
@@ -226,9 +226,9 @@ public final class Utilities {
* In order to provide useful support for this problem, this queue has been
* provided.
* <P>
- * If you have a reference that needs cleanup, make it implement
<link>Runnable</link>
+ * If you have a reference that needs cleanup, make it implement {@link
Runnable}
* and register it with the queue:
- * <PRE>
+ * <PRE>{@code
* class MyReference extends WeakReference<Thing> implements Runnable {
* private final OtherInfo dataToCleanUp;
* public MyReference(Thing ref, OtherInfo data) {
@@ -239,7 +239,7 @@ public final class Utilities {
* dataToCleanUp.releaseOrWhateverYouNeed();
* }
* }
- * </PRE>
+ * }</PRE>
* When the <code>ref</code> object is garbage collected, your run method
* will be invoked by calling
* <code>((Runnable) reference).run()</code>
@@ -291,8 +291,8 @@ public final class Utilities {
/** Test whether a given string is a valid Java identifier.
* @param id string which should be checked
* @return <code>true</code> if a valid identifier
- * @see SourceVersion#isIdentifier
- * @see SourceVersion#isKeyword
+ * @see javax.lang.model.SourceVersion#isIdentifier
+ * @see javax.lang.model.SourceVersion#isKeyword
*/
public static boolean isJavaIdentifier(String id) {
return BaseUtilities.isJavaIdentifier(id);
@@ -699,9 +699,9 @@ public final class Utilities {
* <li>Include command names with embedded spaces, such as <code>c:\Program
Files\jdk\bin\javac</code>.
* <li>Include extra command arguments, such as <code>-Dname=value</code>.
* <li>Do anything else which might require unusual characters or
processing. For example:
- * <p><code><pre>
+ * <pre>{@code
* "c:\program files\jdk\bin\java" -Dmessage="Hello /\\/\\ there!" -Xmx128m
- * </pre></code>
+ * }</pre>
* <p>This example would create the following executable name and arguments:
* <ol>
* <li> <code>c:\program files\jdk\bin\java</code>
@@ -1187,7 +1187,7 @@ public final class Utilities {
* system menus and the like.
* On certain platforms this methods uses a cache to avoid performance
degradation due to repeated calls.
* This can be disabled by setting the property
"-Dnetbeans.screen.insetsCache=false"
- * See issue http://netbeans.org/bugzilla/show_bug.cgi?id=219507
+ * See issue https://bz.apache.org/netbeans/show_bug.cgi?id=219507
*
* @param gconf the GraphicsConfiguration of the monitor
* @return the rectangle of the screen where one can place windows
@@ -1344,13 +1344,13 @@ public final class Utilities {
/**
* This is for use in situations where a standard swing API,
- * such as {@linkplain JOptionPane.show*} or {@linkplain
JFileChooser.show*},
+ * such as {@linkplain javax.swing.JOptionPane}.show* or {@linkplain
javax.swing.JFileChooser}.show*,
* is used to display a dialog. {@code null} should never be used
* as a dialog's parent because it
* frequently does the wrong thing in a multi-screen setup.
* <p>
* The use of the NetBeans API
- * {@linkplain DialogDisplayer.getDefault.*}
+ * <a
href="@org-openide-dialogs@/org/openide/DialogDisplayer.html#getDefault--">DialogDisplayer.getDefault*</a>
* is encouraged to display a dialog, but stuff happens.
* @return A suitable parent component for swing dialog displayers.
* @since 9.26
@@ -1393,7 +1393,7 @@ public final class Utilities {
* @param parent
* @param approveButtonText
* @deprecated Not needed in JDK 1.4.
- * @see <a
href="@org-openide-filesystems@/org/openide/filesystems/FileChooserBuilder.html"><code>FileChooserBuilder</code></a>
+ * @see <a
href="@org-openide-filesystems-nb@/org/openide/filesystems/FileChooserBuilder.html"><code>FileChooserBuilder</code></a>
*/
@Deprecated
public static int showJFileChooser(
@@ -1595,7 +1595,7 @@ public final class Utilities {
* @exception TopologicalSortException if the sort cannot succeed due to
cycles in the graph, the
* exception contains additional information to describe and possibly
recover from the error
* @since 3.30
- * @see <a
href="http://www.netbeans.org/issues/show_bug.cgi?id=27286">Issue #27286</a>
+ * @see <a
href="https://bz.apache.org/netbeans/show_bug.cgi?id=27286">Issue #27286</a>
*/
public static <T> List<T> topologicalSort(Collection<? extends T> c, Map<?
super T, ? extends Collection<? extends T>> edges)
throws TopologicalSortException {
@@ -1639,24 +1639,24 @@ public final class Utilities {
* Btw. one can use spaces instead of <code>=</code> sign.
* For a real world example
* check the
- * <a
href="http://www.netbeans.org/source/browse/xml/text-edit/compat/src/META-INF/netbeans/">
+ * <a href="https://github.com/apache/netbeans/tree/master/ide/xml">
* xml module</a>.
*
* <P>
- * For purposes of <link>org.openide.util.io.NbObjectInputStream</link>
there is
+ * For purposes of {@link org.openide.util.io.NbObjectInputStream} there is
* a following special convention:
* If the
* className is not listed as one that is to be renamed, the returned
* string == className, if the className is registered to be renamed
* than the className != returned value, even in a case when
className.equals (retValue)
- * <p/>
+ * <p>
* Similar behaviour applies to <b>filenames</b> provided by layers
(system filesystem). Filenames
* can be also translated to adapt to location changes e.g. in action
registrations. Note that
* <b>no spaces or special characters</b> are allowed in both translated
filenames or translation
* results. Filenames must conform to regexp {@code ^[/a-zA-Z0-9$_.+-]+$}.
Keys and values are treated
* as paths from fs root.
*
- * <p/>
+ * <p>
* Example of file path translation (action registration file has moved):
* <pre>
* # registration ID has changed
@@ -1932,9 +1932,9 @@ public final class Utilities {
/**
* Loads an image based on resource path.
* Exactly like {@link #loadImage(String)} but may do a localized search.
- * For example, requesting
<samp>org/netbeans/modules/foo/resources/foo.gif</samp>
- * might actually find
<samp>org/netbeans/modules/foo/resources/foo_ja.gif</samp>
- * or <samp>org/netbeans/modules/foo/resources/foo_mybranding.gif</samp>.
+ * For example, requesting
<code>org/netbeans/modules/foo/resources/foo.gif</code>
+ * might actually find
<code>org/netbeans/modules/foo/resources/foo_ja.gif</code>
+ * or <code>org/netbeans/modules/foo/resources/foo_mybranding.gif</code>.
*
* <p>Caching of loaded images can be used internally to improve
performance.
*
@@ -2048,7 +2048,7 @@ public final class Utilities {
* and {@link URI#resolve(URI)}.
* @param f a file
* @return a {@code file}-protocol URI which may use the host field
- * @see java.nio.file.Path.toUri
+ * @see java.nio.file.Path#toUri()
* @since 8.25
*/
public static URI toURI(File f) {
@@ -2061,7 +2061,7 @@ public final class Utilities {
* which accepts UNC URIs with a host field.
* @param u a {@code file}-protocol URI which may use the host field
* @return a file
- * @see java.nio.file.Paths.get(java.net.URI)
+ * @see java.nio.file.Paths#get(java.net.URI)
* @since 8.25
*/
public static File toFile(URI u) throws IllegalArgumentException {
@@ -2074,7 +2074,7 @@ public final class Utilities {
* @return a URL using the <code>file</code> protocol
* @throws MalformedURLException for no good reason
* @see #toFile
- * @see <a
href="http://www.netbeans.org/issues/show_bug.cgi?id=29711">Issue #29711</a>
+ * @see <a
href="https://bz.apache.org/netbeans/show_bug.cgi?id=29711">Issue #29711</a>
* @since 3.26
* @deprecated Use {@link #toURI} and {@link URI#toURL} instead under JDK
1.4.
* ({@link File#toURL} is buggy in JDK 1.3 and the bugs are
not fixed in JDK 1.4.)
@@ -2103,7 +2103,7 @@ public final class Utilities {
* @return an absolute file it points to, or <code>null</code> if the URL
* does not seem to point to a file at all
* @see #toURL
- * @see <a
href="http://www.netbeans.org/issues/show_bug.cgi?id=29711">Issue #29711</a>
+ * @see <a
href="https://bz.apache.org/netbeans/show_bug.cgi?id=29711">Issue #29711</a>
* @since 3.26
* @deprecated Use {@link URL#toURI} and {@link #toFile(URI)} instead
under JDK 1.4.
* (There was no proper equivalent under JDK 1.3.)
@@ -2180,7 +2180,7 @@ public final class Utilities {
/** Get the unorderable elements.
* @return the elements
- * @see
Utilities.UnorderableException#Utilities.UnorderableException(Collection,Map)
+ * @see UnorderableException#UnorderableException(Collection,Map)
*/
public Collection getUnorderable() {
return unorderable;
@@ -2188,7 +2188,7 @@ public final class Utilities {
/** Get the dependencies.
* @return the dependencies
- * @see
Utilities.UnorderableException#Utilities.UnorderableException(Collection,Map)
+ * @see UnorderableException#UnorderableException(Collection,Map)
*/
public Map getDeps() {
return deps;
diff --git a/platform/openide.util.ui/src/org/openide/util/VectorIcon.java
b/platform/openide.util.ui/src/org/openide/util/VectorIcon.java
index 07b1de7126..a183d7a8f5 100644
--- a/platform/openide.util.ui/src/org/openide/util/VectorIcon.java
+++ b/platform/openide.util.ui/src/org/openide/util/VectorIcon.java
@@ -44,7 +44,7 @@ import javax.swing.Icon;
* <p>Hand-crafted painting code is a good design choice for icons that are
simple, ubiqutious in
* the UI (e.g. part of the Look-and-Feel), or highly parameterized. Swing's
native Windows L&F
* uses this approach for many of its basic icons; see
- * {@link com.sun.java.swing.plaf.windows.WindowsIconFactory}.
+ * <a
href="https://github.com/openjdk/jdk/blob/master/src/java.desktop/windows/classes/com/sun/java/swing/plaf/windows/WindowsIconFactory.java"
>WindowsIconFactory</a>.
*
* <p>When developing new icons, or adjusting existing ones, use the {@code
VectorIconTester}
* utility found in
diff --git
a/platform/openide.util.ui/src/org/openide/util/datatransfer/ExClipboard.java
b/platform/openide.util.ui/src/org/openide/util/datatransfer/ExClipboard.java
index 659bdaabce..6932eddcc8 100644
---
a/platform/openide.util.ui/src/org/openide/util/datatransfer/ExClipboard.java
+++
b/platform/openide.util.ui/src/org/openide/util/datatransfer/ExClipboard.java
@@ -221,7 +221,7 @@ public abstract class ExClipboard extends Clipboard {
* generally one which adds new flavors based on the existing flavors.
* The recommended usage is as follows:
*
- * <br><code><pre>
+ * <br><pre>{@code
* public Transferable convert (final Transferable t) {
* if (! t.isDataFlavorSupported (fromFlavor)) return t;
* if (t.isDataFlavorSupported (toFlavor)) return t;
@@ -235,7 +235,7 @@ public abstract class ExClipboard extends Clipboard {
* });
* return et;
* }
- * </pre></code>
+ * }</pre>
*
* <br>Note that this does not perform the conversion until
<code>toFlavor</code> is
* actually requested, nor does it advertise <code>toFlavor</code> as
being available
@@ -243,7 +243,7 @@ public abstract class ExClipboard extends Clipboard {
*
* <p>You may also want to convert some flavor to a node selection, in
which case you should do:
*
- * <br><code><pre>
+ * <br><pre>{@code
* public Transferable convert (final Transferable t) {
* if (! t.isDataFlavorSupported (DataFlavor.stringFlavor)) return t;
* if (NodeTransfer.findPaste (t) != null) return t;
@@ -269,7 +269,7 @@ public abstract class ExClipboard extends Clipboard {
* }));
* return et;
* }
- * </pre></code>
+ * }</pre>
*
* <p>Convertors should generally avoid removing flavors from the
transferable,
* or changing the data for an existing flavor.
diff --git
a/platform/queries/src/org/netbeans/api/fileinfo/NonRecursiveFolder.java
b/platform/queries/src/org/netbeans/api/fileinfo/NonRecursiveFolder.java
index c5b88324b3..5e70f8495e 100644
--- a/platform/queries/src/org/netbeans/api/fileinfo/NonRecursiveFolder.java
+++ b/platform/queries/src/org/netbeans/api/fileinfo/NonRecursiveFolder.java
@@ -26,9 +26,9 @@ import org.openide.filesystems.FileObject;
* When an implementation of this interface is contained in the
* lookup of a node, actions on that node should not process the subfolders
* of this folder.
- * It is permitted for a Node to have both the {@link
org.openide.loaders.DataFolder}
+ * It is permitted for a Node to have both the <a
href="@org-openide-loaders@/org/openide/loaders/DataFolder.html">DataFolder</a>
* and NonRecursiveFolder in its lookup. In this case the {@link
NonRecursiveFolder#getFolder} has to
- * return the same {@link FileObject} as the {@link
org.openide.loaders.DataFolder#getPrimaryFile} method.
+ * return the same {@link FileObject} as the <a
href="@org-openide-loaders@/org/openide/loaders/DataObject.html#getPrimaryFile--">DataFolder#getPrimaryFile</a>
method.
* Any action which checks for the NonRecursiveFolder at all must prefer it to
* the DataFolder since it is considered to be more specific information.
*
diff --git a/platform/queries/src/org/netbeans/api/queries/FileBuiltQuery.java
b/platform/queries/src/org/netbeans/api/queries/FileBuiltQuery.java
index dcd61920b6..09ea0549c2 100644
--- a/platform/queries/src/org/netbeans/api/queries/FileBuiltQuery.java
+++ b/platform/queries/src/org/netbeans/api/queries/FileBuiltQuery.java
@@ -47,8 +47,8 @@ public final class FileBuiltQuery {
* This would typically mean that at least its syntax has been
* validated by a build system, some conventional output file exists
* and is at least as new as the source file, etc.
- * For example, for a <samp>Foo.java</samp> source file, this could
- * check whether <samp>Foo.class</samp> exists (in the appropriate
+ * For example, for a <code>Foo.java</code> source file, this could
+ * check whether <code>Foo.class</code> exists (in the appropriate
* build directory) with at least as new a timestamp.
* </p>
* <p>
diff --git
a/platform/queries/src/org/netbeans/spi/queries/FileBuiltQueryImplementation.java
b/platform/queries/src/org/netbeans/spi/queries/FileBuiltQueryImplementation.java
index 08433d8d9f..f07c331924 100644
---
a/platform/queries/src/org/netbeans/spi/queries/FileBuiltQueryImplementation.java
+++
b/platform/queries/src/org/netbeans/spi/queries/FileBuiltQueryImplementation.java
@@ -28,7 +28,7 @@ import org.openide.filesystems.FileObject;
* <p class="nonnormative">
* Rather than registering a global instance, if your implementation
* is applicable only to project-owned files, you should add it to
- * <a
href="@org-netbeans-modules-projectapi@/org/netbeans/api/project/Project.html#getLookup"><code>Project.getLookup()</code></a>
+ * <a
href="@org-netbeans-modules-projectapi@/org/netbeans/api/project/Project.html#getLookup--"><code>Project.getLookup()</code></a>
* and depend on
* the <code>org.netbeans.modules.projectapi</code> module.
* </p>
@@ -44,8 +44,8 @@ public interface FileBuiltQueryImplementation {
* This would typically mean that at least its syntax has been
* validated by a build system, some conventional output file exists
* and is at least as new as the source file, etc.
- * For example, for a <samp>Foo.java</samp> source file, this could
- * check whether <samp>Foo.class</samp> exists (in the appropriate
+ * For example, for a <code>Foo.java</code> source file, this could
+ * check whether <code>Foo.class</code> exists (in the appropriate
* build directory) with at least as new a timestamp.
* @param file a source file which can be built to a direct product
* @return a status object that can be queries and listened to,
diff --git
a/platform/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation.java
b/platform/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation.java
index 66d1b35b72..ea042a30f7 100644
---
a/platform/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation.java
+++
b/platform/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation.java
@@ -27,8 +27,8 @@ import java.io.File;
* <div class="nonnormative">
* <p>
* Could be implemented e.g. by project types which know that certain files or
folders in
- * a project (e.g. <samp>src/</samp>) are intended for VCS sharing while others
- * (e.g. <samp>build/</samp>) are not.
+ * a project (e.g. <code>src/</code>) are intended for VCS sharing while others
+ * (e.g. <code>build/</code>) are not.
* </p>
* <p>
* Note that the Project API module registers a default implementation of this
query
diff --git
a/platform/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation2.java
b/platform/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation2.java
index 708d7d85f3..878bb437c4 100644
---
a/platform/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation2.java
+++
b/platform/queries/src/org/netbeans/spi/queries/SharabilityQueryImplementation2.java
@@ -27,8 +27,8 @@ import org.netbeans.api.queries.SharabilityQuery.Sharability;
* <div class="nonnormative">
* <p>
* Could be implemented e.g. by project types which know that certain files or
folders in
- * a project (e.g. <samp>src/</samp>) are intended for VCS sharing while others
- * (e.g. <samp>build/</samp>) are not.
+ * a project (e.g. <code>src/</code>) are intended for VCS sharing while others
+ * (e.g. <code>build/</code>) are not.
* </p>
* <p>
* Note that the Project API module registers a default implementation of this
query
---------------------------------------------------------------------
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