diff --git a/ide/api.debugger/apichanges.xml b/ide/api.debugger/apichanges.xml index 5dc80e9fcf45..5d5725f22824 100644 --- a/ide/api.debugger/apichanges.xml +++ b/ide/api.debugger/apichanges.xml @@ -298,7 +298,7 @@

In order to be able to register debugger services on System FileSystem, which brings more flexibility and better performance (see also - ), + ), we add non-recursive content of org.openide.util.Lookups.forPath() into debugger lookup. Since debugger needs retrieve context-aware services from the lookup, diff --git a/ide/api.debugger/src/org/netbeans/api/debugger/ActionsManager.java b/ide/api.debugger/src/org/netbeans/api/debugger/ActionsManager.java index cbf40f4d8fc4..d5b0cd3b4ab5 100644 --- a/ide/api.debugger/src/org/netbeans/api/debugger/ActionsManager.java +++ b/ide/api.debugger/src/org/netbeans/api/debugger/ActionsManager.java @@ -164,7 +164,7 @@ public final void doAction (final Object action) { /** * Post action on this DebuggerEngine. * This method does not block till the action is done, - * if {@link #canPostAsynchronously} returns true. + * if #canPostAsynchronously} returns true. * Otherwise it behaves like {@link #doAction}. * The returned task, or * {@link ActionsManagerListener} can be used to diff --git a/ide/api.debugger/src/org/netbeans/api/debugger/Breakpoint.java b/ide/api.debugger/src/org/netbeans/api/debugger/Breakpoint.java index 8306272cfc9d..ec931a656d9e 100644 --- a/ide/api.debugger/src/org/netbeans/api/debugger/Breakpoint.java +++ b/ide/api.debugger/src/org/netbeans/api/debugger/Breakpoint.java @@ -135,7 +135,7 @@ public final synchronized int getHitCountFilter() { /** * Get the style of hit count filtering. - * @return the style of hit count filtering, or null when no count filter is set. + * @return the style of hit count filtering, or null when no count filter is set. */ public final synchronized HIT_COUNT_FILTERING_STYLE getHitCountFilteringStyle() { return hitCountFilteringStyle; @@ -285,7 +285,7 @@ public void setBreakpointsToEnable(@NonNull Set breakpointsToEnable) *

* Not all breakpoint implementations honor dependent breakpoints. * Use {@link #canHaveDependentBreakpoints()} to determine if the operation is supported. - * @param breakpointsToEnable The set of breakpoints. + * @param breakpointsToDisable The set of breakpoints. * @throws UnsupportedOperationException if the breakpoint does not support * dependent breakpoints - see {@link #canHaveDependentBreakpoints()}. * @since 1.35 diff --git a/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerEngine.java b/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerEngine.java index 3d805c2b9528..12c9abccb836 100644 --- a/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerEngine.java +++ b/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerEngine.java @@ -30,9 +30,10 @@ * It provides root of threads hierarchy (call stacks, locals) * and manages debugger actions. * - *


- * - * + *
Description
+ * + * + * *
Description of DebuggerEngine
Description
* Functionality * @@ -52,8 +53,8 @@ *
* Support for aditional services: * DebuggerEngine is final class. That is why the standard method how to - * extend its functionality is using lookup methods ({@link #lookup} and - * {@link #lookupFirst}). + * extend its functionality is using lookup methods ({@link #lookup(String,Class)} and + * {@link #lookupFirst(String,Class)}). * There are two ways how to register some service provider for some * type of DebuggerEngine: *
    diff --git a/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerManager.java b/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerManager.java index d0e78c99983d..0fa20ccfb970 100644 --- a/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerManager.java +++ b/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerManager.java @@ -48,13 +48,14 @@ * {@link org.netbeans.api.debugger.Watch}es. * * - *


    - * - * + *
    Description
    + * + * + * *
    Description of DebuggerManager
    Description
    * Functionality * - * Start & finish debugging: + * Start & finish debugging: * DebuggerManager manages a process of starting a new debugging ( * {@link #startDebugging}). It cooperates with all installed * {@link org.netbeans.spi.debugger.DebuggerEngineProvider}s to create a new @@ -89,7 +90,7 @@ *

    * Watches management: * DebuggerManager keeps list of all shared watches ({@link #getWatches}). - * Watch can be created & added ({@link #createWatch}). + * Watch can be created & added ({@link #createWatch}). * *

    * Support for listening: @@ -227,7 +228,7 @@ public T lookupFirst(String folder, Class service) { /** * Join two lookups together. * The result will merge the lookups. - * The result of its {@link #lookup} method will additionally implement {@link Customizer}. + * The result of its {@link #lookup(String,Class)} method will additionally implement {@link Customizer}. * @param cp1 first lookup * @param cp2 second lookup * @return a merger of the two @@ -624,7 +625,7 @@ public Watch createWatch (String expr) { * a variable name). * @return the new watch * @throws ArrayIndexOutOfBoundsException if the index is out of range - * (index < 0 || index > getWatches().length) + * (index < 0 || index > getWatches().length) * @since 1.22 */ public Watch createWatch (int index, String expr) { diff --git a/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerManagerAdapter.java b/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerManagerAdapter.java index 2883aa86147c..866357fd68ec 100644 --- a/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerManagerAdapter.java +++ b/ide/api.debugger/src/org/netbeans/api/debugger/DebuggerManagerAdapter.java @@ -57,7 +57,6 @@ public void breakpointRemoved (Breakpoint breakpoint) { /** * Called when set of watches is initialized. * - * @return initial set of watches */ public void initWatches () { } diff --git a/ide/api.debugger/src/org/netbeans/api/debugger/Session.java b/ide/api.debugger/src/org/netbeans/api/debugger/Session.java index b43eaef3fde3..d4d4425f2094 100644 --- a/ide/api.debugger/src/org/netbeans/api/debugger/Session.java +++ b/ide/api.debugger/src/org/netbeans/api/debugger/Session.java @@ -31,9 +31,10 @@ * be simple bean with properties like process ID, session name, etc. * All other functionality is delegated to current debugger engine. * - *


    - * - * + *
    Description
    + * + * + * *
    Description of Session
    Description
    * Functionality * @@ -62,8 +63,8 @@ *

    * Support for additional services: * Session is final class. The standard method how to - * extend its functionality is using lookup methods ({@link #lookup} and - * {@link #lookupFirst}). + * extend its functionality is using lookup methods ({@link #lookup(String,Class)} and + * {@link #lookupFirst(String,Class)}). * There are two ways how to register some service provider for some * type of Session: *
      diff --git a/ide/api.debugger/src/org/netbeans/api/debugger/SessionBridge.java b/ide/api.debugger/src/org/netbeans/api/debugger/SessionBridge.java index 16133f4d488d..879538a42796 100644 --- a/ide/api.debugger/src/org/netbeans/api/debugger/SessionBridge.java +++ b/ide/api.debugger/src/org/netbeans/api/debugger/SessionBridge.java @@ -37,7 +37,7 @@ * the debugging session for a debug action. A registered implementation of * {@link SessionChanger} can decide to change the session in order to perform * the given action. - *

      + *

      * In the current implementation, step into action of JPDA debugger is suggested * for a session change only. The support can be extended according to the future * requirements. @@ -93,7 +93,7 @@ public static synchronized SessionBridge getDefault() { * @param properties Properties describing the current state of the current session before the given action. * The actual properties are specific for the particular session type. * @return true when the session is changed and another session - * decided to perform the given action.
      + * decided to perform the given action.
      * false when no other session would like to perform this action. */ public boolean suggestChange(Session origin, String action, Map properties) { @@ -186,7 +186,7 @@ public static interface SessionChanger { * @param properties Session-specific properties describing the state * right before the given action. These are used by a new session * to complete the given action. - * @return A new session, or null when this handler decides + * @return A new session, or null when this handler decides * not to change the debug session for this action. */ Session changeSuggested(Session origin, String action, Map properties); diff --git a/ide/api.debugger/src/org/netbeans/spi/debugger/ContextAwareService.java b/ide/api.debugger/src/org/netbeans/spi/debugger/ContextAwareService.java index 692b0c9bd212..647fa188bae1 100644 --- a/ide/api.debugger/src/org/netbeans/spi/debugger/ContextAwareService.java +++ b/ide/api.debugger/src/org/netbeans/spi/debugger/ContextAwareService.java @@ -34,7 +34,7 @@ * </file> * </folder> * - *
      + *
      * * @author Martin Entlicher * @since 1.16 diff --git a/ide/editor.settings.storage/apichanges.xml b/ide/editor.settings.storage/apichanges.xml index 80d2aa17d31d..b8dd3caf329f 100644 --- a/ide/editor.settings.storage/apichanges.xml +++ b/ide/editor.settings.storage/apichanges.xml @@ -228,7 +228,7 @@ is the proper place.

      The phase 1 of the editor settings enhancements, please see - issue 90403 + issue 90403 for details. Briefly, the changes involve introducing a special folder for each setting type, profiles are always stored in their own folder, modules are allowed to register multiple settings files, diff --git a/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/api/EditorSettings.java b/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/api/EditorSettings.java index 10bf53eab85a..ee285e5f41cd 100644 --- a/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/api/EditorSettings.java +++ b/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/api/EditorSettings.java @@ -30,7 +30,7 @@ /** * This singleton class contains access methods for editor settings like - * font & colors profiles and keymaps. + * font & colors profiles and keymaps. * * @author Jan Jancura */ @@ -103,9 +103,9 @@ public static EditorSettings getDefault () { public static final String PROP_MIME_TYPES = MimeTypesTracker.PROP_MIME_TYPES; /** - * Returns set of font & colors profiles. + * Returns set of font & colors profiles. * - * @return set of font & colors profiles + * @return set of font & colors profiles */ public abstract Set getFontColorProfiles (); @@ -118,25 +118,25 @@ public static EditorSettings getDefault () { public abstract boolean isCustomFontColorProfile (String profile); /** - * Returns name of current font & colors profile. + * Returns name of current font & colors profile. * - * @return name of current font & colors profile + * @return name of current font & colors profile */ public abstract String getCurrentFontColorProfile (); /** - * Sets current font & colors profile. + * Sets current font & colors profile. * * @param profile a profile name */ public abstract void setCurrentFontColorProfile (String profile); /** - * Returns font & color defaults for given profile or null, if the profile + * Returns font & color defaults for given profile or null, if the profile * is unknown . * * @param profile a profile name - * @return font & color defaults for given profile or null + * @return font & color defaults for given profile or null * * @deprecated Use getFontColorSettings(new String[0]).getAllFontColors(profile) instead. */ @@ -146,11 +146,11 @@ public abstract Collection getDefaultFontColors ( ); /** - * Returns default values for font & color defaults for given profile + * Returns default values for font & color defaults for given profile * or null, if the profile is unknown. * * @param profile a profile name - * @return font & color defaults for given profile or null + * @return font & color defaults for given profile or null * * @deprecated Use getFontColorSettings(new String[0]).getAllFontColorsDefaults(profile) instead. */ @@ -160,10 +160,10 @@ public abstract Collection getDefaultFontColorDefaults ( ); /** - * Sets font & color defaults for given profile. + * Sets font & color defaults for given profile. * * @param profile a profile name - * @param fontColors font & color defaults to be used + * @param fontColors font & color defaults to be used * * @deprecated Use getFontColorSettings(new String[0]).setAllFontColors(profile, fontColors) instead. */ @@ -267,7 +267,7 @@ public abstract void setAnnotations ( /** * Returns set of keymap profiles. * - * @return set of font & colors profiles + * @return set of font & colors profiles */ public abstract Set getKeyMapProfiles (); diff --git a/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/api/FontColorSettingsFactory.java b/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/api/FontColorSettingsFactory.java index 54500e224ed8..267f0fc573fb 100644 --- a/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/api/FontColorSettingsFactory.java +++ b/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/api/FontColorSettingsFactory.java @@ -23,7 +23,7 @@ import javax.swing.text.AttributeSet; /** - * Getters and setters for font & color editor profiles. Instances of this + * Getters and setters for font & color editor profiles. Instances of this * class should be registered in MimeLookup for particular mime types. * * @author Jan Jancura @@ -41,12 +41,12 @@ public abstract class FontColorSettingsFactory { public abstract Collection getAllFontColors (String profile); /** - * Gets default values for all font & colors for given profile, or null + * Gets default values for all font & colors for given profile, or null * if profile does not exist or if it does not have any defaults. * * @param profile the name of profile * - * @return default values for all font & colors + * @return default values for all font & colors */ public abstract Collection getAllFontColorDefaults (String profile); diff --git a/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/spi/support/StorageSupport.java b/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/spi/support/StorageSupport.java index 4a87f252db13..df971e1184d2 100644 --- a/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/spi/support/StorageSupport.java +++ b/ide/editor.settings.storage/src/org/netbeans/modules/editor/settings/storage/spi/support/StorageSupport.java @@ -48,7 +48,7 @@ public static String getLocalizingBundleMessage(FileObject fo, String key, Strin /** * Converts a list of KeyStrokes to its textual representation. There * are two available formats for the textual representation: - * + *

        *
      • Human readable - this format encodes a KeyStroke to * a string that looks like for example 'Ctrl+A' or 'Alt+Shift+M'. *
      • Emacs style - this format encodes a KeyStroke to @@ -56,14 +56,14 @@ public static String getLocalizingBundleMessage(FileObject fo, String key, Strin * It uses methods from org.openide.util.Utilities, which take * care of Mac OS specifics and use 'D' and 'O' wildcards for encoding 'Ctrl' * and 'Alt' keys. - * + *
      * @param keys The KeyStrokes to convert. * @param emacsStyle If true the returned string will be in so called * Emacs style, ortherwise it will be in human readable format. * * @return The textual representation of KeyStrokes passed in. * @since 1.16 - * @deprecated Use {@link KeyStrokeUtils#getKeyStrokesAsText} or {@link Utilities#keyToString(javax.swing.KeyStroke[], java.lang.String, boolean)} + * @deprecated Use {@link KeyStrokeUtils#getKeyStrokesAsText} or {@link Utilities#keyToString(javax.swing.KeyStroke, boolean)} */ public static String keyStrokesToString(Collection keys, boolean emacsStyle) { if (!emacsStyle) { @@ -84,7 +84,7 @@ public static String keyStrokesToString(Collection keys, bo /** * Converts a textual representation of key strokes to an array of KeyStroke - * objects. Please see {@link #keyStrokesToString(Collection, boolean)} + * objects. Please see {@link #keyStrokesToString(Collection, boolean)} * ror details about the available formats. * * @param key The textual representation of keystorkes to convert. Its format diff --git a/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/api/Symbol.java b/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/api/Symbol.java index cf18960dc641..56aba3ec7584 100644 --- a/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/api/Symbol.java +++ b/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/api/Symbol.java @@ -36,7 +36,7 @@ private Symbol(String name, String type, String description) { } /** - * Get the symbol name. Never null. + * Get the symbol name. Never null. * * @since 0.2 */ diff --git a/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/api/debug/NIDebugger.java b/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/api/debug/NIDebugger.java index 21d3511ff68d..f4a212fce1ef 100644 --- a/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/api/debug/NIDebugger.java +++ b/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/api/debug/NIDebugger.java @@ -152,7 +152,7 @@ private CompletableFuture startLegacy(StartDebugParameters debugParameters * @param startedEngine the corresponding DebuggerEngine is passed to this consumer * @return future that completes on the execution finish * @since 0.4 - * @deprecated Use {@link #start(StartDebugParameters, Consumer) and set {@link StartDebugParameters.Builder#processID(long)}. + * @deprecated Use {@link #start(StartDebugParameters, Consumer)} and set {@link StartDebugParameters.Builder#processID(Long)}. */ @Deprecated public CompletableFuture attach(String executablePath, long processId, String debugger, Consumer startedEngine) { diff --git a/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/spi/debug/NIDebuggerProvider.java b/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/spi/debug/NIDebuggerProvider.java index 0f3d5090138f..4fd04275fdf1 100644 --- a/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/spi/debug/NIDebuggerProvider.java +++ b/ide/nativeimage.api/src/org/netbeans/modules/nativeimage/spi/debug/NIDebuggerProvider.java @@ -127,7 +127,7 @@ default CompletableFuture start(StartDebugParameters debugParameters, Cons * @param startedEngine the corresponding DebuggerEngine is passed to this consumer * @return future that completes on the execution finish * @since 0.4 - * @deprecated Use {@link #start(StartDebugParameters, Consumer)} and set {@link StartDebugParameters.Builder#processID(long)}. + * @deprecated Use {@link #start(StartDebugParameters, Consumer)} and set {@link StartDebugParameters.Builder#processID(Long)}. */ @Deprecated default CompletableFuture attach(String executablePath, long processId, String debugger, Consumer startedEngine) { diff --git a/ide/parsing.api/src/org/netbeans/modules/parsing/api/ParserManager.java b/ide/parsing.api/src/org/netbeans/modules/parsing/api/ParserManager.java index 2b2fdac4b881..7ade6f71493f 100644 --- a/ide/parsing.api/src/org/netbeans/modules/parsing/api/ParserManager.java +++ b/ide/parsing.api/src/org/netbeans/modules/parsing/api/ParserManager.java @@ -304,7 +304,7 @@ public void remove() { /** * Runs given task in parser thread. - * @param mimetype specifying the parser + * @param mimeType specifying the parser * @param userTask a user task * @throws ParseException encapsulating the user exception */ @@ -325,7 +325,7 @@ public static void parse ( * scan is running the method behaves exactly like the {#link ParserManager#parse}, * it performs the given task synchronously (in caller thread). If there is an another {@link UserTask} * running this method waits until it's completed. - * @param mimetype A mimetype specifying the parser. + * @param mimeType A mimetype specifying the parser. * @param userTask A task started when parsing is done. * @return {@link Future} which can be used to find out the state of the task {@link Future#isDone} or {@link Future#isCancelled}. * The caller may cancel the task using {@link Future#cancel} or wait until the task is performed {@link Future#get}. @@ -388,7 +388,7 @@ public static boolean isParsing() { } /** - * Determines if the MIME type can be parsed. Rejects unknown MIME types (must be amongst {@link #getAllMimeTypes}. + * Determines if the MIME type can be parsed. Rejects unknown MIME types (must be amongst getAllMimeTypes. * Then accepts only text/* MIME type and specific hardcoded application/ MIME types. * * @param mimeType the MIME type to check diff --git a/ide/parsing.api/src/org/netbeans/modules/parsing/api/Source.java b/ide/parsing.api/src/org/netbeans/modules/parsing/api/Source.java index f886f9e8748c..8afd727ff4de 100644 --- a/ide/parsing.api/src/org/netbeans/modules/parsing/api/Source.java +++ b/ide/parsing.api/src/org/netbeans/modules/parsing/api/Source.java @@ -124,7 +124,7 @@ public static Source create ( * Gets a Source instance for a file. The FileObject * passed to this method has to be a valid data file. There is no Source * representation for a folder. - *

      + *

      * This form allows to specify Lookup that provides access to context-dependent * services for the parsing system and the user tasks called from parsing API. * @@ -183,7 +183,7 @@ public static Source create ( } /** - * Gets a Source instance for a Document. For details, please + * Gets a Source instance for a Document. For details, please * see {@link #create(javax.swing.text.Document)}; this form allows to specify * a Lookup that provides access to user or context-dependent services. * @@ -972,7 +972,7 @@ public ExtendableSourceModificationEvent add(boolean changed, int start, int end * Returns a Lookup providing a context for the source. * In the presence of multiple scopes or users in the system, this Lookup may * provide access to necessary context-dependent services or scope-dependent data. - *

      + *

      * A Source may be created with a Lookup, or it will use the default Lookup as a context * @return Lookup. * @since 9.2 diff --git a/ide/parsing.api/src/org/netbeans/modules/parsing/spi/Parser.java b/ide/parsing.api/src/org/netbeans/modules/parsing/spi/Parser.java index 8648f2326b4e..509cb46a6a3b 100644 --- a/ide/parsing.api/src/org/netbeans/modules/parsing/spi/Parser.java +++ b/ide/parsing.api/src/org/netbeans/modules/parsing/spi/Parser.java @@ -83,7 +83,7 @@ public abstract Result getResult ( /** * Called by the infrastructure to stop the parser operation. - * @param reason of the cancel, see {@link Parser#CancelReason} + * @param reason of the cancel, see {@link Parser.CancelReason} * @param event an additional info if the reason is SOURCE_MODIFICATION_EVENT, otherwise null * @since */ @@ -121,7 +121,7 @@ public abstract static class Result { /** * Creates a {@link Result} for given snapshot - * @param snapshot + * @param _snapshot */ protected Result ( final Snapshot _snapshot diff --git a/ide/parsing.api/src/org/netbeans/modules/parsing/spi/Scheduler.java b/ide/parsing.api/src/org/netbeans/modules/parsing/spi/Scheduler.java index 9c43144e2d4f..9c00915d6502 100644 --- a/ide/parsing.api/src/org/netbeans/modules/parsing/spi/Scheduler.java +++ b/ide/parsing.api/src/org/netbeans/modules/parsing/spi/Scheduler.java @@ -119,7 +119,7 @@ protected final synchronized void schedule ( * Reschedule all tasks registered for this Scheduler (see * {@link ParserResultTask#getSchedulerClass()}, and sets new {@link Source}s for them. * - * @param sources A collection of {@link Source}s. + * @param source A {@link Source}. */ //tzezula: really unclear usages of sources field (synchronization, live cycle, may it be called twice with different set of sources?). //tzezula: should set CHANGE_EXPECTED flag on the sources. diff --git a/ide/parsing.api/src/org/netbeans/modules/parsing/spi/support/CancelSupport.java b/ide/parsing.api/src/org/netbeans/modules/parsing/spi/support/CancelSupport.java index 1a1b898c99e1..cc76873ce320 100644 --- a/ide/parsing.api/src/org/netbeans/modules/parsing/spi/support/CancelSupport.java +++ b/ide/parsing.api/src/org/netbeans/modules/parsing/spi/support/CancelSupport.java @@ -43,7 +43,6 @@ * } * } * - *

      * @since 1.74 * @author Tomas Zezula */ diff --git a/ide/parsing.indexing/src/org/netbeans/modules/parsing/api/indexing/IndexingManager.java b/ide/parsing.indexing/src/org/netbeans/modules/parsing/api/indexing/IndexingManager.java index 491cf225d464..b48004e6aaf1 100644 --- a/ide/parsing.indexing/src/org/netbeans/modules/parsing/api/indexing/IndexingManager.java +++ b/ide/parsing.indexing/src/org/netbeans/modules/parsing/api/indexing/IndexingManager.java @@ -77,7 +77,7 @@ public boolean isIndexing() { * job will take. * * @param root The common parent folder of the files that should be reindexed. - * @param filesOrFolders The files to reindex. Can be null or an empty + * @param files The files to reindex. Can be null or an empty * collection in which case all files under the root will * be reindexed. */ @@ -102,7 +102,7 @@ public void refreshIndex(URL root, Collection files) { * job will take. * * @param root The common parent folder of the files that should be reindexed. - * @param filesOrFolders The files to reindex. Can be null or an empty + * @param files The files to reindex. Can be null or an empty * collection in which case all files under the root will * be reindexed. * @param fullRescan If true no timestamps check will be done @@ -138,7 +138,7 @@ public void refreshIndex(URL root, Collection files, boolean full * should be preferred. * * @param root The common parent folder of the files that should be reindexed. - * @param filesOrFolders The files to reindex. Can be null or an empty + * @param files The files to reindex. Can be null or an empty * collection in which case all files under the root will * be reindexed. * @param fullRescan If true no timestamps check will be done @@ -165,7 +165,7 @@ public void refreshIndex(@NonNull URL root, @NullAllowed Collectionnull or an empty + * @param files The files to reindex. Can be null or an empty * collection in which case all files under the root will * be reindexed. */ @@ -183,7 +183,7 @@ public void refreshIndexAndWait(URL root, Collection files) { * job will take. * * @param root The common parent folder of the files that should be reindexed. - * @param filesOrFolders The files to reindex. Can be null or an empty + * @param files The files to reindex. Can be null or an empty * collection in which case all files under the root will * be reindexed. * @param fullRescan If true no timestamps check will be done @@ -244,8 +244,7 @@ public void refreshIndexAndWait(URL root, Collection files, boole * indexers will be refreshed (ie. all types of indexers will used, * not just CustomIndexers). * - * @since 1.8 - * @since + * @since 1.8 */ public void refreshAllIndices(String indexerName) { if (indexerName != null) { diff --git a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/ConstrainedBinaryIndexer.java b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/ConstrainedBinaryIndexer.java index 09446d21282d..4e8fc0cb5110 100644 --- a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/ConstrainedBinaryIndexer.java +++ b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/ConstrainedBinaryIndexer.java @@ -32,7 +32,7 @@ * An binary indexer with declared constraints on the binary. * The subclasses of this indexer are registered by {@link ConstrainedBinaryIndexer.Registration}. * @author Tomas Zezula - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> * @since 1.48 */ public abstract class ConstrainedBinaryIndexer { diff --git a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/CustomIndexerFactory.java b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/CustomIndexerFactory.java index f93b6a86219e..532f55c4569f 100644 --- a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/CustomIndexerFactory.java +++ b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/CustomIndexerFactory.java @@ -34,7 +34,7 @@ public abstract class CustomIndexerFactory extends SourceIndexerFactory { /** - * Creates new {@link Indexer}. + * Creates new {@link CustomIndexer}. * @return an indexer */ public abstract CustomIndexer createIndexer (); diff --git a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/EmbeddingIndexerFactory.java b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/EmbeddingIndexerFactory.java index a6460d0385a5..97166d14dfa1 100644 --- a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/EmbeddingIndexerFactory.java +++ b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/EmbeddingIndexerFactory.java @@ -35,8 +35,8 @@ public abstract class EmbeddingIndexerFactory extends SourceIndexerFactory { /** - * Creates new {@link Indexer}. - * @param indexing for which the indexer should be created + * Creates new {@link EmbeddingIndexer}. + * @param indexable for which the indexer should be created * @param snapshot for which the indexer should be created * @return an indexer */ diff --git a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/IndexabilityQueryImplementation.java b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/IndexabilityQueryImplementation.java index 2ac705821073..6e4c91f6c4b1 100644 --- a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/IndexabilityQueryImplementation.java +++ b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/IndexabilityQueryImplementation.java @@ -34,7 +34,7 @@ * {@link org.openide.filesystems} with respect to threading semantics. *

      * - * @see org.netbeans.api.queries.IndexabilityQuery + * @see org.netbeans.modules.parsing.impl.indexing.IndexabilityQuery * @since org.netbeans.modules.parsing.indexing 9.24.0 */ public interface IndexabilityQueryImplementation { diff --git a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/PathRecognizer.java b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/PathRecognizer.java index 137fce2569ce..c8d3af11cdc3 100644 --- a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/PathRecognizer.java +++ b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/PathRecognizer.java @@ -30,21 +30,21 @@ public abstract class PathRecognizer { /** * Returns names under which the source paths are registered in - * the {@link GlobalPathRegistry} + * the GlobalPathRegistry. * @return set of source path names */ public abstract Set getSourcePathIds (); /** * Returns names under which the library paths are registered in - * the {@link GlobalPathRegistry}. + * the GlobalPathRegistry. * @return set of library path names */ public abstract Set getLibraryPathIds (); /** * Returns names under which the binary library paths are registered in - * the {@link GlobalPathRegistry}. + * the GlobalPathRegistry. * @return set of binary library path names */ public abstract Set getBinaryLibraryPathIds (); diff --git a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/SourceIndexerFactory.java b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/SourceIndexerFactory.java index ea1f7bfbb234..7f7052df8991 100644 --- a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/SourceIndexerFactory.java +++ b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/SourceIndexerFactory.java @@ -75,7 +75,7 @@ public int getPriority() { /** * Called by indexing infrastructure to allow indexer to clean indexes for deleted files. * @param deleted the collection of deleted {@link Indexable}s - * @param contents an indexing context + * @param context an indexing context *
      *

      If the {@link IndexingSupport} is used to implement the {@link SourceIndexerFactory} * the implementation of this method should delegate to {@link IndexingSupport#isValid()}

      diff --git a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/support/IndexingSupport.java b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/support/IndexingSupport.java index f98db09a6e2d..b39b91503ed9 100644 --- a/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/support/IndexingSupport.java +++ b/ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/support/IndexingSupport.java @@ -101,7 +101,7 @@ public boolean isValid() { /** * Creates a new {@link IndexDocument}. This method does exactly the same as - * {@link #createDocument(org.netbeans.modules.parsing.spi.indexing.Indexable), but you can + * {@link #createDocument(org.netbeans.modules.parsing.spi.indexing.Indexable)}, but you can * use FileObjects directly. The FileObject passed in * as a parameter has to be in the folders hierarchy under the root, which * this IndexingSupport instance was created for. diff --git a/ide/project.ant/src/org/netbeans/api/project/ant/AntArtifact.java b/ide/project.ant/src/org/netbeans/api/project/ant/AntArtifact.java index 808e06ea261e..e4232b39c252 100644 --- a/ide/project.ant/src/org/netbeans/api/project/ant/AntArtifact.java +++ b/ide/project.ant/src/org/netbeans/api/project/ant/AntArtifact.java @@ -45,7 +45,7 @@ * For example, if a build script is known to generate a JAR of a certain name * as a result of running a certain target, this object will name that JAR * and point to the script and target responsible for creating it. You can use - * this information to add an <ant> task to another project + * this information to add an <ant> task to another project * which will generate that JAR as a dependency before using it. * @see org.netbeans.spi.project.support.ant.SimpleAntArtifact * @author Jesse Glick @@ -91,21 +91,21 @@ protected AntArtifact() { /** * Get a location for the Ant script that is able to produce this artifact. - * The name build.xml is conventional. + * The name build.xml is conventional. * @return the location of an Ant project file (might not currently exist) */ public abstract File getScriptLocation(); /** * Get the name of the Ant target that is able to produce this artifact. - * E.g. jar would be conventional for JAR artifacts. + * E.g. jar would be conventional for JAR artifacts. * @return an Ant target name */ public abstract String getTargetName(); /** * Get the name of an Ant target that will delete this artifact. - * Typically this should be clean. + * Typically this should be clean. * The target may delete other build products as well. * @return an Ant target name */ @@ -126,7 +126,7 @@ public URI getArtifactLocation() { private static final Set warnedClasses = Collections.synchronizedSet(new HashSet()); /** * Get the locations of the build artifacts relative to the Ant script. - * For example, dist/mylib.jar. The method is not defined + * For example, dist/mylib.jar. The method is not defined * as abstract only for backward compatibility reasons. It must be * overridden. The order is important and should stay the same * unless the artifact was changed. diff --git a/ide/project.ant/src/org/netbeans/spi/project/ant/AntBuildExtenderImplementation.java b/ide/project.ant/src/org/netbeans/spi/project/ant/AntBuildExtenderImplementation.java index 6afe30b3a985..3150476c1851 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/ant/AntBuildExtenderImplementation.java +++ b/ide/project.ant/src/org/netbeans/spi/project/ant/AntBuildExtenderImplementation.java @@ -27,9 +27,9 @@ * A typical setup in the project type includes: *
        *
      • Provide an instance of {@link org.netbeans.api.project.ant.AntBuildExtender} in project's lookup for use by 3rd - * party modules. + * party modules.
        • *
      • Use the new {@link org.netbeans.spi.project.support.ant.GeneratedFilesHelper#GeneratedFilesHelper(AntProjectHelper,AntBuildExtender)} constructor to - * create the helper for generating build related files. + * create the helper for generating build related files.
        • *
      * @author mkleint * @since org.netbeans.modules.project.ant 1.16 diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntBasedProjectRegistration.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntBasedProjectRegistration.java index eaade8ed8089..784e59915840 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntBasedProjectRegistration.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntBasedProjectRegistration.java @@ -58,7 +58,7 @@ * the project's specific configuration data in nbproject/project.xml * (inside <configuration>). * - * @return a simple name; data is recommended but not required + * @return a simple name; data is recommended but not required */ String sharedName() default "data"; @@ -67,8 +67,8 @@ * the project's specific configuration data in nbproject/project.xml * (inside <configuration>). * - * @return an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project - * or http://www.netbeans.org/ns/j2se-project-private + * @return an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project + * or http://www.netbeans.org/ns/j2se-project-private */ String sharedNamespace(); @@ -77,7 +77,7 @@ * the project's specific configuration data in nbproject/private/private.xml * (inside <project-private>). * - * @return a simple name; data is recommended but not required + * @return a simple name; data is recommended but not required */ String privateName() default "data"; @@ -86,8 +86,8 @@ * the project's specific configuration data in nbproject/private/private.xml * (inside <project-private>). * - * @return an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project - * or http://www.netbeans.org/ns/j2se-project-private + * @return an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project + * or http://www.netbeans.org/ns/j2se-project-private */ String privateNamespace(); } diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntBasedProjectType.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntBasedProjectType.java index 6e2018bc3023..74c262ae343e 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntBasedProjectType.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntBasedProjectType.java @@ -58,7 +58,7 @@ public interface AntBasedProjectType { * It is forbidden for the result of this method to change from call to call. * @param shared if true, refers to project.xml, else refers to * private.xml - * @return a simple name; data is recommended but not required + * @return a simple name; data is recommended but not required */ String getPrimaryConfigurationDataElementName(boolean shared); @@ -70,8 +70,8 @@ public interface AntBasedProjectType { * It is forbidden for the result of this method to change from call to call. * @param shared if true, refers to project.xml, else refers to * private.xml - * @return an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project - * or http://www.netbeans.org/ns/j2se-project-private + * @return an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project + * or http://www.netbeans.org/ns/j2se-project-private */ String getPrimaryConfigurationDataElementNamespace(boolean shared); diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntProjectHelper.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntProjectHelper.java index 41a4e1512129..785012cbfc52 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntProjectHelper.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/AntProjectHelper.java @@ -1052,7 +1052,7 @@ public AuxiliaryProperties createAuxiliaryProperties() { * A file is considered out of date if there is no file represented by the * matching target pattern (which has the same format), or the target file is older * than the source file, or the source file is modified as per - * {@link org.openide.loaders.DataObject#isModified}. + * DataObject#isModified(). * An attempt is made to fire changes from the status object whenever the result * should change from one call to the next. *

      @@ -1064,12 +1064,12 @@ public AuxiliaryProperties createAuxiliaryProperties() { * A typical set of source and target patterns would be: *

      *
        - *
      1. ${src.dir}/*.java - *
      2. ${test.src.dir}/*.java + *
      3. ${src.dir}/*.java + *
      4. ${test.src.dir}/*.java *
      *
        - *
      1. ${build.classes.dir}/*.class - *
      2. ${test.build.classes.dir}/*.class + *
      3. ${build.classes.dir}/*.class + *
      4. ${test.build.classes.dir}/*.class *
      *
      * @param eval a property evaluator to interpret the patterns with @@ -1089,12 +1089,12 @@ public FileBuiltQueryImplementation createGlobFileBuiltQuery(PropertyEvaluator e * is in a fixed location under a standard Ant-based project. * @param type the type of artifact, e.g. JavaProjectConstants.ARTIFACT_TYPE_JAR * @param locationProperty an Ant property name giving the project-relative - * location of the artifact, e.g. dist.jar + * location of the artifact, e.g. dist.jar * @param eval a way to evaluate the location property (e.g. {@link #getStandardPropertyEvaluator}) * @param targetName the name of an Ant target which will build the artifact, - * e.g. jar + * e.g. jar * @param cleanTargetName the name of an Ant target which will delete the artifact - * (and maybe other build products), e.g. clean + * (and maybe other build products), e.g. clean * @return an artifact */ public AntArtifact createSimpleAntArtifact(String type, String locationProperty, PropertyEvaluator eval, String targetName, String cleanTargetName) { @@ -1106,14 +1106,14 @@ public AntArtifact createSimpleAntArtifact(String type, String locationProperty, * is in a fixed location under a standard Ant-based project. * @param type the type of artifact, e.g. JavaProjectConstants.ARTIFACT_TYPE_JAR * @param locationProperty an Ant property name giving the project-relative - * location of the artifact, e.g. dist.jar + * location of the artifact, e.g. dist.jar * @param eval a way to evaluate the location property (e.g. {@link #getStandardPropertyEvaluator}) * @param targetName the name of an Ant target which will build the artifact, - * e.g. jar + * e.g. jar * @param cleanTargetName the name of an Ant target which will delete the artifact - * (and maybe other build products), e.g. clean + * (and maybe other build products), e.g. clean * @param buildScriptProperty an Ant property name giving the project-relative - * location and name of the build.xml or null if default one (build.xml) + * location and name of the build.xml or null if default one (build.xml) * should be used; default value is also used if property is given but its value is null * @return an artifact * @since org.netbeans.modules.project.ant/1 1.25 @@ -1172,10 +1172,10 @@ public AntArtifact createSimpleAntArtifact(String type, String locationProperty, * A quick rule of thumb is that the include list should contain any * source directories which might reside outside the project directory; * and the exclude list should contain any directories which you would want - * to add to a .cvsignore file if using CVS (for example). + * to add to a .cvsignore file if using CVS (for example). *

      *

      - * Note that in this case ${src.dir} and ${test.src.dir} + * Note that in this case ${src.dir} and ${test.src.dir} * may be relative paths inside the project directory; relative paths pointing * outside of the project directory; or absolute paths (generally outside of the * project directory). If they refer to locations inside the project directory, diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/EditableProperties.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/EditableProperties.java index 1ea3742ab2f6..ae219434e5ee 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/EditableProperties.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/EditableProperties.java @@ -29,7 +29,7 @@ /** * Similar to {@link java.util.Properties} but designed to retain additional * information needed for safe hand-editing. - * Useful for various *.properties in a project: + * Useful for various *.properties in a project: *

        *
      1. Can associate comments with particular entries. *
      2. Order of entries preserved during modifications whenever possible. @@ -142,7 +142,7 @@ public String setProperty(String key, String value) { * Same behavior as {@link #setProperty(String,String)} with the difference that each item * will be stored on its own line of text. {@link #getProperty} will simply concatenate * all the items into one string, so generally separators - * (such as : for path-like properties) must be included in + * (such as : for path-like properties) must be included in * the items (for example, at the end of all but the last item). * @param key a property name; cannot be null nor empty * @param value the desired value; cannot be null; can be empty array diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/PathMatcher.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/PathMatcher.java index f257582755c9..d102584dd0db 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/PathMatcher.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/PathMatcher.java @@ -43,41 +43,41 @@ * The format is based on Ant patterns. Some details: *

        *
          - *
        • A file path to be matched must be a /-separated + *
        • A file path to be matched must be a /-separated * relative path from an unspecified base directory. A path representing - * a folder must end in /, except for the path representing + * a folder must end in /, except for the path representing * the root folder, which is the empty string. Thus, the full path to a file * is always the simple concatenation of the path to its containing folder, * and the file's basename. *
        • An include or exclude list, if not null, is a list of nonempty patterns separated * by spaces and/or commas. It may be an empty list; this is equivalent to null in the * case of excludes, but in the case of includes means that nothing matches. - *
        • A pattern may use either / or \ as a path separator + *
        • A pattern may use either / or \ as a path separator * interchangeably. *
        • Most characters in a pattern match literally, and match a complete file path. - * A folder path ends in /, so the pattern foo will not - * match a folder named foo. - *
        • * in a pattern matches zero or more characters within a path component - * (i.e. not including /). - *
        • ** matches zero or more complete path components. It must be preceded + * A folder path ends in /, so the pattern foo will not + * match a folder named foo. + *
        • * in a pattern matches zero or more characters within a path component + * (i.e. not including /). + *
        • ** matches zero or more complete path components. It must be preceded * by a slash (or be at the beginning of the pattern) and be followed by a slash (or be at * the end of the pattern). - *
        • foo/ is treated the same as foo/** and matches the whole - * tree rooted at the folder foo. - *
        • /**/ can match just a single /. **/ - * and /** can match the empty string at path boundaries. + *
        • foo/ is treated the same as foo/** and matches the whole + * tree rooted at the folder foo. + *
        • /**/ can match just a single /. **/ + * and /** can match the empty string at path boundaries. *
        *

        * Some example patterns: *

        *
        - *
        foo/bar/ - *
        The folder foo/bar and anything inside it. - *
        foo/bar/baz - *
        The file foo/bar/baz. - *
        **/foo/ - *
        Any folder named foo and anything inside it. - *
        **/*.java + *
        foo/bar/ + *
        The folder foo/bar and anything inside it. + *
        foo/bar/baz + *
        The file foo/bar/baz. + *
        **/foo/ + *
        Any folder named foo and anything inside it. + *
        **/*.java *
        Any Java source file (even in the default package). *
        * @since org.netbeans.modules.project.ant/1 1.15 @@ -184,8 +184,8 @@ public boolean matches(String path, boolean useKnownIncludes) { * Find folders which match although their parent folders do not; or folders * which do not match but which contain files which do. *
          - *
        • Wildcard-free folder include paths, such as foo/bar/ (or the - * equivalent foo/bar/**), are returned directly if they are not excluded. + *
        • Wildcard-free folder include paths, such as foo/bar/ (or the + * equivalent foo/bar/**), are returned directly if they are not excluded. *
        • Wildcard-using paths trigger a scan of the provided root directory. * Any actual files or folders found beneath that root which {@link #matches match} * are noted, and their minimal paths are returned. diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/PropertyEvaluator.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/PropertyEvaluator.java index ee241ccc94ab..b5bc8a9682b0 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/PropertyEvaluator.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/PropertyEvaluator.java @@ -46,9 +46,9 @@ public interface PropertyEvaluator { /** * Evaluate a block of text possibly containing property references. - * The syntax is the same as for Ant: ${foo} means the value - * of the property foo; $$ is an escape for - * $; references to undefined properties are left unsubstituted. + * The syntax is the same as for Ant: ${foo} means the value + * of the property foo; $$ is an escape for + * $; references to undefined properties are left unsubstituted. * @param text some text possibly containing one or more property references * @return its value, or null if some problem (such a circular definition) made * it impossible to retrieve the values of some properties diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/PropertyUtils.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/PropertyUtils.java index 20842e882a5b..608f30ec1a91 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/PropertyUtils.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/PropertyUtils.java @@ -389,7 +389,7 @@ public static File resolveFile(File basedir, String filename) throws IllegalArgu * @param basedir a directory to resolve relative to (need not exist on disk) * @param file a file or directory to find a relative path for * @return a relativized path (slash-separated), or null if it is not possible (e.g. different DOS drives); - * just . in case the paths are the same + * just . in case the paths are the same * @throws IllegalArgumentException if the basedir is known to be a file and not a directory */ public static @CheckForNull String relativizeFile(File basedir, File file) { @@ -458,7 +458,7 @@ private static String slashify(String path) { /** * Split an Ant-style path specification into components. * Tokenizes on : and ;, paying - * attention to DOS-style components such as C:\FOO. + * attention to DOS-style components such as C:\FOO. * Also removes any empty components. * @param path an Ant-style path (elements arbitrary) using DOS or Unix separators * @return a tokenization of that path into components diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/ReferenceHelper.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/ReferenceHelper.java index 256afc2a4c68..af682e8a6aa8 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/ReferenceHelper.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/ReferenceHelper.java @@ -397,15 +397,15 @@ private boolean setPathPropertyImpl(String propertyName, String[] values, String * Adds a project property if necessary to refer to its location of the foreign * project - a shared property if the foreign project * is {@link CollocationQuery collocated} with this one, else a private property. - * This property is named project.foreignProjectName. - * Example: project.mylib=../mylib + * This property is named project.foreignProjectName. + * Example: project.mylib=../mylib *

          * Adds a project property to refer to the artifact's location. - * This property is named reference.foreignProjectName.targetName - * and will use ${project.foreignProjectName} and be a shared + * This property is named reference.foreignProjectName.targetName + * and will use ${project.foreignProjectName} and be a shared * property - unless the artifact location is an absolute URI, in which case the property * will also be private. - * Example: reference.mylib.jar=${project.mylib}/dist/mylib.jar + * Example: reference.mylib.jar=${project.mylib}/dist/mylib.jar *

          * Also records the artifact type, (relative) script path, and build and * clean target names. @@ -941,7 +941,7 @@ public String createForeignFileReference(final File file, final String expectedA * the behavior is identical to {@link #createForeignFileReference(AntArtifact)}. *

          * Acquires write access. - * @param path a file path to refer to (need not currently exist) + * @param filepath a file path to refer to (need not currently exist) * @param expectedArtifactType the required {@link AntArtifact#getType} * @return a string which can refer to that file somehow * diff --git a/ide/project.ant/src/org/netbeans/spi/project/support/ant/SourcesHelper.java b/ide/project.ant/src/org/netbeans/spi/project/support/ant/SourcesHelper.java index 00a2abd4132d..b3bad8cc4f0f 100644 --- a/ide/project.ant/src/org/netbeans/spi/project/support/ant/SourcesHelper.java +++ b/ide/project.ant/src/org/netbeans/spi/project/support/ant/SourcesHelper.java @@ -366,7 +366,6 @@ public SourcesHelper(Project project, AntProjectHelper aph, PropertyEvaluator ev * .add() // adding as principal root, continuing configuration * .type("java").add(); // adding as typed root * - *

          * @since org.netbeans.modules.project.ant/1 1.33 */ public final class SourceRootConfig { @@ -399,7 +398,7 @@ public SourceRootConfig displayName(String value) { * Value is evaluated and then treated as a comma- or space-separated pattern list, * as detailed in the Javadoc for {@link PathMatcher}. * (As a special convenience, a value consisting solely of an Ant property reference - * which cannot be evaluated, e.g. ${undefined}, is ignored.) + * which cannot be evaluated, e.g. ${undefined}, is ignored.) * {@link SourceGroup#contains} will then reflect the includes and excludes for files, but note that the * semantics of that method requires that a folder be "contained" in case any folder or file * beneath it is contained, and in particular the root folder is always contained. @@ -527,7 +526,7 @@ public SourceRootConfig add() throws IllegalStateException { * if the common location is internal. *

          *

          - * Source location need not to exist physically, when {@link #hint(String) hint} is specified + * Source location need not to exist physically, when {@link SourceRootConfig#hint(String) hint} is specified * and {@link SourceGroupModifier} created by this helper is added to project * lookup, source root can be created on demand. *

          @@ -540,7 +539,6 @@ public SourceRootConfig add() throws IllegalStateException { * @param location a project-relative or absolute path giving the location * of a source tree; may contain Ant property substitutions * @return source root configuration, that may be added to SourcesHelper - * @see SourceRootConfig#location(String) for details about location parameter */ public SourceRootConfig sourceRoot(String location) { return new SourceRootConfig(location); diff --git a/ide/project.libraries/src/org/netbeans/spi/project/libraries/ArealLibraryProvider.java b/ide/project.libraries/src/org/netbeans/spi/project/libraries/ArealLibraryProvider.java index 8e4423af0377..537812efc771 100644 --- a/ide/project.libraries/src/org/netbeans/spi/project/libraries/ArealLibraryProvider.java +++ b/ide/project.libraries/src/org/netbeans/spi/project/libraries/ArealLibraryProvider.java @@ -29,8 +29,8 @@ /** * Library provider which can define libraries in particular areas. * There is no explicit method to save a library; setters on {@link LibraryImplementation} should do this. - * @param A the type of storage area used by this provider - * @param L the type of library created by this provider + * @param the type of storage area used by this provider + * @param the type of library created by this provider * @since org.netbeans.modules.project.libraries/1 1.15 */ public interface ArealLibraryProvider { diff --git a/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryFactory.java b/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryFactory.java index 998c3343b901..6ce8365957f9 100644 --- a/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryFactory.java +++ b/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryFactory.java @@ -39,7 +39,7 @@ private LibraryFactory() { /** * Creates Library for LibraryImplementation * @param libraryImplementation the library SPI object - * @return Library API instance, for which the {@link Library#getManager} will be {@link LibraryManager#getDefault} + * @return Library API instance, for which the {@link Library#getManager()} will be {@link org.netbeans.api.project.libraries.LibraryManager#getDefault()} */ public static Library createLibrary (LibraryImplementation libraryImplementation) { assert libraryImplementation != null; diff --git a/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryProvider.java b/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryProvider.java index 2077ab1b4cf5..43dd96b0e253 100644 --- a/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryProvider.java +++ b/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryProvider.java @@ -26,7 +26,7 @@ * Library storage is a source of libraries used by LibraryManager. * LibraryManager allows existence of multiple LibraryProviders registered in * the default lookup. - * @param L the type of implementation which will be produced by this provider + * @param the type of implementation which will be produced by this provider */ public interface LibraryProvider { diff --git a/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryTypeProvider.java b/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryTypeProvider.java index b473e6ec6a2a..bde9450776ba 100644 --- a/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryTypeProvider.java +++ b/ide/project.libraries/src/org/netbeans/spi/project/libraries/LibraryTypeProvider.java @@ -53,8 +53,8 @@ public interface LibraryTypeProvider extends Lookup.Provider { /** * Creates a new empty library implementation. - * Generally will use {@link LibrariesSupport#createLibraryImplementation}. - * This method is not used by {@link LibraryManager#createLibrary} except in the case of {@link LibraryManager#getDefault}. + * Generally will use {@link org.netbeans.spi.project.libraries.support.LibrariesSupport#createLibraryImplementation}. + * This method is not used by {@link org.netbeans.api.project.libraries.LibraryManager#createLibrary} except in the case of {@link org.netbeans.api.project.libraries.LibraryManager#getDefault}. * @return the created library model, never null */ public LibraryImplementation createLibrary (); @@ -65,7 +65,7 @@ public interface LibraryTypeProvider extends Lookup.Provider { * If the LibraryTypeProvider implementation requires clean of * additional settings (e.g. remove properties in the build.properties) * it should be done in this method. - * This method is not used by {@link LibraryManager#createLibrary} except in the case of {@link LibraryManager#getDefault}. + * This method is not used by {@link org.netbeans.api.project.libraries.LibraryManager#createLibrary} except in the case of {@link org.netbeans.api.project.libraries.LibraryManager#getDefault}. * @param libraryImpl */ public void libraryDeleted (LibraryImplementation libraryImpl); @@ -77,7 +77,7 @@ public interface LibraryTypeProvider extends Lookup.Provider { * If the LibraryTypeProvider implementation requires initialization of * additional settings (e.g. adding properties into the build.properties) * it should be done in this method. - * This method is not used by {@link LibraryManager#createLibrary} except in the case of {@link LibraryManager#getDefault}. + * This method is not used by {@link org.netbeans.api.project.libraries.LibraryManager#createLibrary} except in the case of {@link org.netbeans.api.project.libraries.LibraryManager#getDefault}. */ public void libraryCreated (LibraryImplementation libraryImpl); diff --git a/ide/project.libraries/src/org/netbeans/spi/project/libraries/WritableLibraryProvider.java b/ide/project.libraries/src/org/netbeans/spi/project/libraries/WritableLibraryProvider.java index 0f9a188f17c2..7f89606d9db5 100644 --- a/ide/project.libraries/src/org/netbeans/spi/project/libraries/WritableLibraryProvider.java +++ b/ide/project.libraries/src/org/netbeans/spi/project/libraries/WritableLibraryProvider.java @@ -24,7 +24,7 @@ /** * LibraryProvider supporting modifications. - * @param L the {@link LibraryImplementation} type + * @param the {@link LibraryImplementation} type * @author Tomas Zezula * @since 1.48 */ diff --git a/ide/project.libraries/src/org/netbeans/spi/project/libraries/support/LibrariesSupport.java b/ide/project.libraries/src/org/netbeans/spi/project/libraries/support/LibrariesSupport.java index b393d2bc1179..6ad912ee65ec 100644 --- a/ide/project.libraries/src/org/netbeans/spi/project/libraries/support/LibrariesSupport.java +++ b/ide/project.libraries/src/org/netbeans/spi/project/libraries/support/LibrariesSupport.java @@ -68,8 +68,8 @@ private LibrariesSupport () { /** * Policy for handling content items which cannot be converted into the desired format. - * @see #convertURIsToURLs(java.util.List) - * @see #convertURLsToURIs(java.util.List) + * @see #convertURIsToURLs(java.util.List,ConversionMode) + * @see #convertURLsToURIs(java.util.List,ConversionMode) * @since 1.48 */ public enum ConversionMode { @@ -82,7 +82,7 @@ public enum ConversionMode { */ WARN, /** - * {@link #toString(ClassPath.PathConversionMode)} will fail with an {@link IllegalArgumentException}. + * toString(ClassPath.PathConversionMode) will fail with an {@link IllegalArgumentException}. * Useful for unit tests. */ FAIL diff --git a/ide/projectapi/src/org/netbeans/api/project/FileOwnerQuery.java b/ide/projectapi/src/org/netbeans/api/project/FileOwnerQuery.java index be21e0fbd407..629d08130063 100644 --- a/ide/projectapi/src/org/netbeans/api/project/FileOwnerQuery.java +++ b/ide/projectapi/src/org/netbeans/api/project/FileOwnerQuery.java @@ -44,7 +44,7 @@ * other implementations can be registered to lookup as well. *

          * Warning: This class and it's methods may not be used within DataObject recognition in DataLoaders. - * eg. in {@link org.openide.loaders.MultiFileLoader#findPrimaryFile} + * eg. in MultiFileLoader * * @author Jesse Glick */ diff --git a/ide/projectapi/src/org/netbeans/api/project/ProjectActionContext.java b/ide/projectapi/src/org/netbeans/api/project/ProjectActionContext.java index ba3fef804134..2d142e98cf13 100644 --- a/ide/projectapi/src/org/netbeans/api/project/ProjectActionContext.java +++ b/ide/projectapi/src/org/netbeans/api/project/ProjectActionContext.java @@ -220,7 +220,7 @@ public Builder withLookup(Lookup lkp) { /** * Binds to a specific {@link ProjectConfiguration}, which must resolve to an instance of - * {@link MavenConfiguration}. + * @see MavenConfiguration. * @param configuration * @return builder instance */ diff --git a/ide/projectapi/src/org/netbeans/api/project/SourceGroupModifier.java b/ide/projectapi/src/org/netbeans/api/project/SourceGroupModifier.java index 0ef2c76c02f2..50d9763695d9 100644 --- a/ide/projectapi/src/org/netbeans/api/project/SourceGroupModifier.java +++ b/ide/projectapi/src/org/netbeans/api/project/SourceGroupModifier.java @@ -59,13 +59,13 @@ public static final SourceGroup createSourceGroup(Project project, String type, * Creates a source group associated to an existing one. In a project with multiple locations for sources or tests some of those locations * can be more appropriate (or completely unrelated) to already existing specific sources. This variant of {@link #createSourceGroup(org.netbeans.api.project.Project, java.lang.String, java.lang.String)} * allows to select appropriate locations, if the newly created {@code SourceGroup} should work in association with some existing one. - *

          + *

          * The source group will be created on location most similar to the provided {@code original} group. If {@code projectParts} are specified, the most matching * location will be selected. - *

          + *

          * This feature is prototypically used in J2SE modular projects, where multiple locations exists for tests and sources, yet they are related by their owning module. Other * project types may also partition project sources into logical groups, similar to modules. - *

          + *

          * Some (java) examples: *

            *
          • to create a source folder in project module, use relativeTo(modulesGroup, "moduleName").createSourceGroup(..) diff --git a/ide/projectapi/src/org/netbeans/spi/project/ActionProvider.java b/ide/projectapi/src/org/netbeans/spi/project/ActionProvider.java index 8c143f82c097..65098b8435c7 100644 --- a/ide/projectapi/src/org/netbeans/spi/project/ActionProvider.java +++ b/ide/projectapi/src/org/netbeans/spi/project/ActionProvider.java @@ -35,7 +35,7 @@ * requested a specific configuration, and use it to process the requested action, if found. * @see org.netbeans.api.project.Project#getLookup * @see ActionUtils - * @see ProjectSensitiveActions.projectCommandAction(...) + * @see ProjectSensitiveActions.projectCommandAction(...) * @see SingleMethod * @author Jesse Glick */ @@ -175,7 +175,7 @@ public interface ActionProvider { * to get e.g. the selected source file to build by itself, etc. * @param command a predefined command name (must be among {@link #getSupportedActions}) * @param context any action context, e.g. for a node selection - * (as in {@link ContextAwareAction}) + * (as in {@link org.openide.util.ContextAwareAction}) * @throws IllegalArgumentException if the requested command is not supported * @see ActionProgress */ @@ -188,7 +188,7 @@ public interface ActionProvider { * to get e.g. the selected source file to build by itself, etc. * @param command a predefined command name (must be among {@link #getSupportedActions}) * @param context any action context, e.g. for a node selection - * (as in {@link ContextAwareAction}) + * (as in {@link org.openide.util.ContextAwareAction}) * @throws IllegalArgumentException if the requested command is not supported */ boolean isActionEnabled(String command, Lookup context) throws IllegalArgumentException; diff --git a/ide/projectapi/src/org/netbeans/spi/project/LookupMerger.java b/ide/projectapi/src/org/netbeans/spi/project/LookupMerger.java index 05efc2dcbfdd..ff22b5e50362 100644 --- a/ide/projectapi/src/org/netbeans/spi/project/LookupMerger.java +++ b/ide/projectapi/src/org/netbeans/spi/project/LookupMerger.java @@ -36,7 +36,7 @@ * The 3rd party {@link org.netbeans.spi.project.LookupProvider} implementors provide instances of mergeableClass. * {@link org.netbeans.spi.project.support.LookupProviderSupport#createCompositeLookup} handles the hiding of individual mergeable instances * and exposing the merged instance created by the LookupMerger. - * @param T the type of object being merged (see {@link org.netbeans.api.project.Project#getLookup} for examples) + * @param the type of object being merged (see {@link org.netbeans.api.project.Project#getLookup} for examples) * @author mkleint * @since org.netbeans.modules.projectapi 1.12 */ diff --git a/ide/projectapi/src/org/netbeans/spi/project/ProjectConfigurationProvider.java b/ide/projectapi/src/org/netbeans/spi/project/ProjectConfigurationProvider.java index 816d8c89afe1..b820a58f73e0 100644 --- a/ide/projectapi/src/org/netbeans/spi/project/ProjectConfigurationProvider.java +++ b/ide/projectapi/src/org/netbeans/spi/project/ProjectConfigurationProvider.java @@ -28,7 +28,7 @@ * Provider of configurations for a project. * Should be registered in a project's {@link org.netbeans.api.project.Project#getLookup lookup}. * Besides the implementor, only the project UI infrastructure is expected to use this class. - * @param C the type of configuration created by this provider + * @param the type of configuration created by this provider * * @author Adam Sotona, Jesse Glick * @since org.netbeans.modules.projectapi/1 1.11 diff --git a/ide/projectapi/src/org/netbeans/spi/project/SourceGroupRelativeModifierImplementation.java b/ide/projectapi/src/org/netbeans/spi/project/SourceGroupRelativeModifierImplementation.java index 3cbbbcac54d7..7a3f46430af3 100644 --- a/ide/projectapi/src/org/netbeans/spi/project/SourceGroupRelativeModifierImplementation.java +++ b/ide/projectapi/src/org/netbeans/spi/project/SourceGroupRelativeModifierImplementation.java @@ -24,18 +24,18 @@ * Intermediate level for more structured projects, where the simple * type-based information are not sufficient to create an appropriate folder * structure. - *

            + *

            * Prototypically used in J2SE Modular projects, where tests or sources belong * to different modules, and it is critical to create the folder in the "correct" * one. - *

            + *

            * The project can be partitioned to several (hiearchical) parts. SourceGroups for * certain types/hints can be created in some of those parts (see {@link SourceGroupModifierImplementation#canCreateSourceGroup}. * For example, java modular projects contains modules, a module may contain several places where sources are expected - these * form the part hierarchy. When the original SourceGroup is specific enough, the hierarchy argument may be * missing or can be even ignored by the modifier implementation - provided that the newly created folders have the correct * relationship to the original source group. - *

            + *

            * Similar structure may be used in other types of projects. {@code projectParts} are abstract uninterpreted identifiers, so * the implementation / project may choose any semantics suitable for the project type. * @author sdedic diff --git a/ide/projectuiapi.base/src/org/netbeans/api/project/ui/OpenProjects.java b/ide/projectuiapi.base/src/org/netbeans/api/project/ui/OpenProjects.java index c3403dea3f25..5acbbbbcf0bf 100644 --- a/ide/projectuiapi.base/src/org/netbeans/api/project/ui/OpenProjects.java +++ b/ide/projectuiapi.base/src/org/netbeans/api/project/ui/OpenProjects.java @@ -46,8 +46,8 @@ * For many cases, however, this API is not the correct approach, so use it as * a last resort. Consider GlobalPathRegistry, * {@link org.netbeans.spi.project.ui.ProjectOpenedHook}, - * and {@link org.netbeans.spi.project.ui.support.ProjectSensitiveActions} - * (or {@link org.netbeans.spi.project.ui.support.MainProjectSensitiveActions}) + * and ProjectSensitiveActions + * (or MainProjectSensitiveActions) * first. Only certain operations should actually be aware of which projects * are "open"; by default, all project functionality should be available whether * it is open or not. @@ -108,7 +108,7 @@ public static OpenProjects getDefault() { * and opened on background. As soon as and no sooner before * all opened projects are opened, the * return value of this method changes and appropriate property change - * event with PROPERTY_OPEN_PROJECTS is delivered. + * event with {@link #PROPERTY_OPEN_PROJECTS} is delivered. * * * @return list of projects currently opened in the IDE's GUI; order not specified @@ -122,7 +122,7 @@ public Project[] getOpenProjects() { * opening of a project may take long time, and as there can be multiple * projects open at once, it may be necessary to be notified that the process * of open project list modification started or that it has - * finished. This method provides a future that can do that. + * finished. This method provides a future that can do that. * To find out that the list of open projects is currently modified use: * 

                  * assert openProjects().isDone() == false;
@@ -134,7 +134,7 @@ public Project[] getOpenProjects() {
      *
            * This result is different that a plain call to {@link #getOpenProjects} as * that methods returns the current state, whatever it is. While the call through - * the future awaits for current modifications to finish. As such wait + * the future awaits for current modifications to finish. As such wait * can take a long time one can also wait for just a limited amount of time. * However this waiting methods should very likely only be used from dedicated threads, * where the wait does not block other essencial operations (read: do not @@ -158,7 +158,7 @@ public Future openProjects() { * {@link org.openide.WizardDescriptor.InstantiatingIterator#instantiate} * should return the project directory. * This should also not be used to provide a GUI to open subprojects; - * {@link CommonProjectActions#openSubprojectsAction} should be used instead. + * CommonProjectActions#openSubprojectsAction should be used instead. *

            * @param projects to be opened. If some of the projects are already opened * these projects are ignored. If the list contain duplicates, the duplicated @@ -184,7 +184,7 @@ public void open (Project[] projects, boolean openSubprojects) { * {@link org.openide.WizardDescriptor.InstantiatingIterator#instantiate} * should return the project directory. * This should also not be used to provide a GUI to open subprojects; - * {@link CommonProjectActions#openSubprojectsAction} should be used instead. + * CommonProjectActions#openSubprojectsAction should be used instead. *

            * @param projects to be opened. If some of the projects are already opened * these projects are ignored. If the list contain duplicates, the duplicated @@ -235,7 +235,7 @@ public void close (Project[] projects) { * *
            *

            Warning: the set of usecases that require invoking this method is - * limited. {@link org.netbeans.spi.project.ui.support.MainProjectSensitiveActions} should + * limited. MainProjectSensitiveActions should * be used in favour of this method if possible. In particular, this method should not * be used to let the user choose if an action should be run on the main vs. the currently selected project.

            *

            As a rule of thumb, any code outside of the project system infrastructure which behaves differently diff --git a/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/PrivilegedTemplates.java b/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/PrivilegedTemplates.java index eaf40ad425a4..603d137cd095 100644 --- a/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/PrivilegedTemplates.java +++ b/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/PrivilegedTemplates.java @@ -31,15 +31,15 @@ * *

            * For more information about registering templates see overview of - * {@link org.netbeans.spi.project.ui.templates.support} package. - * @see org.netbeans.spi.project.ui.support.CommonProjectActions + * org.netbeans.spi.project.ui.templates.support package. + * @see CommonProjectActions * @author Petr Hrebejk */ public interface PrivilegedTemplates { /** * Lists privileged templates. - * @return full paths to privileged templates, e.g. Templates/Other/XmlFile.xml + * @return full paths to privileged templates, e.g. Templates/Other/XmlFile.xml * @see org.netbeans.api.templates.TemplateRegistration#folder * @see org.netbeans.api.templates.TemplateRegistration#content * @see org.netbeans.api.templates.TemplateRegistration#id diff --git a/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/ProjectProblemsProvider.java b/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/ProjectProblemsProvider.java index 8a199990e7e9..aa87f558e94d 100644 --- a/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/ProjectProblemsProvider.java +++ b/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/ProjectProblemsProvider.java @@ -51,7 +51,7 @@ path = "Projects/org-netbeans-modules-myproject/Actions") }) * - *

            + * *
            * * @see org.netbeans.spi.project.ui.support.ProjectProblemsProviderSupport @@ -279,7 +279,7 @@ public boolean equals(final Object other) { } /** - * {@inheritdoc} + * {@inheritDoc} */ @Override public int hashCode() { @@ -291,7 +291,7 @@ public int hashCode() { } /** - * {@inheritdoc} + * {@inheritDoc} */ @Override public String toString() { diff --git a/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/support/ProjectConvertors.java b/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/support/ProjectConvertors.java index fc315f1aa197..f081e308d81a 100644 --- a/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/support/ProjectConvertors.java +++ b/ide/projectuiapi.base/src/org/netbeans/spi/project/ui/support/ProjectConvertors.java @@ -107,7 +107,7 @@ public static FileEncodingQueryImplementation createFileEncodingQuery() { * The returned {@link Lookup} implements {@link Closeable}, calling {@link Closeable#close} * on it removes all the instances. *

            - * Typical usage would be to pass the {@link Lookup} to {@link ProjectConvertor.Result#Result} + * Typical usage would be to pass the {@link Lookup} to {@link ProjectConvertor.Result#Result(org.openide.util.Lookup, java.util.concurrent.Callable, java.lang.String, javax.swing.Icon) } * and call {@link Closeable#close} on it in the convertor's project factory before the real * project is created. *

            diff --git a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/DnDNodeModelFilter.java b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/DnDNodeModelFilter.java index ba89d9363b5c..6b7f752c607d 100644 --- a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/DnDNodeModelFilter.java +++ b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/DnDNodeModelFilter.java @@ -67,7 +67,7 @@ public interface DnDNodeModelFilter extends NodeModelFilter { * on provided transferable when drop is done. * * @param original The original DnDNodeModel to filter - * @param node The node where to drop + * @param object The node where to drop * @param t the transferable to drop * @param action the Drag and Drop action from {@link java.awt.dnd.DnDConstants} * @param index index between children the drop occured at or -1 if not specified diff --git a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/ExtendedNodeModel.java b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/ExtendedNodeModel.java index 71e8967f1b01..f1717b06ab0b 100644 --- a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/ExtendedNodeModel.java +++ b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/ExtendedNodeModel.java @@ -113,7 +113,7 @@ public interface ExtendedNodeModel extends NodeModel { /** * Returns icon resource with extension for given node. - * This is the preferred way of icon specification over {@link org.netbeans.spi.viewmodel.NodeModel.getIconBase} + * This is the preferred way of icon specification over {@link org.netbeans.spi.viewmodel.NodeModel#getIconBase} * * @param node The node object * @return The base resouce name with extension (no initial slash) diff --git a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/ExtendedNodeModelFilter.java b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/ExtendedNodeModelFilter.java index 59ffb811f61c..cc1b7656b99c 100644 --- a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/ExtendedNodeModelFilter.java +++ b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/ExtendedNodeModelFilter.java @@ -112,7 +112,7 @@ public interface ExtendedNodeModelFilter extends NodeModelFilter { /** * Returns icon resource with extension for given node. - * This is the preferred way of icon specification over {@link org.netbeans.spi.viewmodel.NodeModel.getIconBase} + * This is the preferred way of icon specification over {@link org.netbeans.spi.viewmodel.NodeModel#getIconBase} * * @param node The node object * @return The base resouce name with extension (no initial slash) diff --git a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/Models.java b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/Models.java index e6258923f206..89ea9fc872fb 100644 --- a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/Models.java +++ b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/Models.java @@ -4525,7 +4525,6 @@ public String getIconBase (Object node) * * @throws UnknownTypeException if this NodeActionsProvider implementation * is not able to resolve actions for given node type - * @return display name for given node */ @Override public void performDefaultAction (Object node) throws UnknownTypeException { diff --git a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/NodeActionsProvider.java b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/NodeActionsProvider.java index f94fe55b10c7..5166445ff26c 100644 --- a/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/NodeActionsProvider.java +++ b/ide/spi.viewmodel/src/org/netbeans/spi/viewmodel/NodeActionsProvider.java @@ -36,7 +36,6 @@ public interface NodeActionsProvider extends Model { * * @throws UnknownTypeException if this NodeActionsProvider implementation * is not able to resolve actions for given node type - * @return display name for given node */ public abstract void performDefaultAction (Object node) throws UnknownTypeException; diff --git a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/CallStackFrame.java b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/CallStackFrame.java index ab834354577d..202c95b8f398 100644 --- a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/CallStackFrame.java +++ b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/CallStackFrame.java @@ -94,7 +94,7 @@ public interface CallStackFrame { * * @param struts a language name or null for default language * @return name of file this stack frame is stopped in - * @throws NoInformationException if information about source is not + * @throws AbsentInformationException if information about source is not * included in class file */ public abstract String getSourceName (String struts) diff --git a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/ExceptionBreakpoint.java b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/ExceptionBreakpoint.java index 2de94bca6006..d57b8b31a5eb 100644 --- a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/ExceptionBreakpoint.java +++ b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/ExceptionBreakpoint.java @@ -104,7 +104,7 @@ private ExceptionBreakpoint () { * * @param exceptionClassName class name filter * @param catchType one of constants: {@link #TYPE_EXCEPTION_CAUGHT}, - * {@link #TYPE_EXCEPTION_UNCAUGHT, {@link #TYPE_EXCEPTION_CAUGHT_UNCAUGHT}. + * {@link #TYPE_EXCEPTION_UNCAUGHT}, {@link #TYPE_EXCEPTION_CAUGHT_UNCAUGHT}. * @return a new breakpoint for given parameters */ public static ExceptionBreakpoint create ( diff --git a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/Field.java b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/Field.java index 292c285b650f..50abe057f5df 100644 --- a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/Field.java +++ b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/Field.java @@ -72,7 +72,6 @@ public interface Field extends MutableVariable { /** * Sets value of this field represented as text. * - * @return sets value of this field represented as text * @throws InvalidExpressionException if the expression is not correct */ @Override diff --git a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/JPDADebugger.java b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/JPDADebugger.java index d073f2216805..7450c3120b5d 100644 --- a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/JPDADebugger.java +++ b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/JPDADebugger.java @@ -153,15 +153,15 @@ public static void launch ( * * @param connector The listening connector * @param args The arguments - * @param services The additional services, which are added to the debugger session lookup.
            - * It is expected, that one element in the services array is a {@link Map} with following setup properties:
            - * + * @param services The additional services, which are added to the debugger session lookup.
            + * It is expected, that one element in the services array is a {@link Map} with following setup properties:
            + *
              *
            • name with the value being the session name as String,
              • *
            • sourcepath with the {@link ClassPath} value containing class path of sources used by debugger,
              • *
            • jdksources with the {@link ClassPath} value containing class path of platform sources,
              • *
            • listeningCP optional String representation of source class path which is in compile-on-save mode, which we listen on for artifacts changes,
              • *
            • baseDir with the debugging project's base directory as {@link File}.
              • - * + *
            */ public static JPDADebugger listen ( ListeningConnector connector, @@ -201,7 +201,7 @@ public static JPDADebugger listen ( * * @param connector The listening connector * @param args The arguments - * @param services The additional services, which are added to the debugger session lookup.
            + * @param services The additional services, which are added to the debugger session lookup.
            * See {@link #listen(com.sun.jdi.connect.ListeningConnector, java.util.Map, java.lang.Object[])} for a more detailed description of this argument. * @throws DebuggerStartException when {@link org.netbeans.api.debugger.DebuggerManager#startDebugging} * returns an empty array @@ -223,7 +223,7 @@ public static void startListening ( * * @param connector The listening connector * @param args The arguments - * @param services The additional services, which are added to the debugger session lookup.
            + * @param services The additional services, which are added to the debugger session lookup.
            * See {@link #listen(com.sun.jdi.connect.ListeningConnector, java.util.Map, java.lang.Object[])} for a more detailed description of this argument. * @return A non-empty array of started engines (since 2.26) * @throws DebuggerStartException when {@link org.netbeans.api.debugger.DebuggerManager#startDebugging} @@ -262,15 +262,15 @@ public static DebuggerEngine[] startListeningAndGetEngines ( * * @param hostName a name of computer to attach to * @param portNumber a port number - * @param services The additional services, which are added to the debugger session lookup.
            - * It is expected, that one element in the services array is a {@link Map} with following setup properties:
            - * + * @param services The additional services, which are added to the debugger session lookup.
            + * It is expected, that one element in the services array is a {@link Map} with following setup properties:
            + *
              *
            • name with the value being the session name as String,
              • *
            • sourcepath with the {@link ClassPath} value containing class path of sources used by debugger,
              • *
            • jdksources with the {@link ClassPath} value containing class path of platform sources,
              • *
            • listeningCP optional String representation of source class path which is in compile-on-save mode, which we listen on for artifacts changes,
              • *
            • baseDir with the debugging project's base directory as {@link File}.
              • - * + *
            */ public static JPDADebugger attach ( String hostName, @@ -309,7 +309,7 @@ public static JPDADebugger attach ( * {@link org.netbeans.api.debugger.DebuggerManager#getDebuggerManager}. * * @param name a name of shared memory block - * @param services The additional services, which are added to the debugger session lookup.
            + * @param services The additional services, which are added to the debugger session lookup.
            * See {@link #attach(java.lang.String, int, java.lang.Object[])} for a more detailed description of this argument. */ public static JPDADebugger attach ( @@ -413,10 +413,10 @@ public abstract Variable evaluate (String expression) public abstract void waitRunning () throws DebuggerStartException; /** - * Returns true if this debugger supports fix & continue + * Returns true if this debugger supports fix & continue * (HotSwap). * - * @return true if this debugger supports fix & continue + * @return true if this debugger supports fix & continue */ public abstract boolean canFixClasses (); @@ -439,7 +439,7 @@ public boolean canBeModified() { } /** - * Implements fix & continue (HotSwap). Map should contain class names + * Implements fix & continue (HotSwap). Map should contain class names * as a keys, and byte[] arrays as a values. * * @param classes a map from class names to be fixed to byte[] diff --git a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/JPDAThread.java b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/JPDAThread.java index e5e7e491288e..cb2fa144211d 100644 --- a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/JPDAThread.java +++ b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/JPDAThread.java @@ -109,7 +109,7 @@ public interface JPDAThread { /** * Returns the operation that is being currently executed on this thread. * @return The current operation, or null. - * @see {@link CallStackFrame#getCurrentOperation} + * @see CallStackFrame#getCurrentOperation(String) */ public abstract Operation getCurrentOperation(); diff --git a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/LineBreakpoint.java b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/LineBreakpoint.java index a2d9cabef36e..78726be196d7 100644 --- a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/LineBreakpoint.java +++ b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/LineBreakpoint.java @@ -397,7 +397,7 @@ public void setPreferredClassName(String className) { /** * Gets the binary class name that is used to submit the breakpoint. - * @return The binary class name, if previously set by {@link setPreferedClassName} + * @return The binary class name, if previously set by {@link #setPreferredClassName} * method, or null if the class name should be retrieved * automatically from the URL and line number. * @since 2.8 diff --git a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/MethodBreakpoint.java b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/MethodBreakpoint.java index fe1d7efcf707..f0ac5effbe7c 100644 --- a/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/MethodBreakpoint.java +++ b/java/api.debugger.jpda/src/org/netbeans/api/debugger/jpda/MethodBreakpoint.java @@ -41,11 +41,11 @@ * *

            * How to use it: - * 
            + * 
            
  *    DebuggerManager.addBreakpoint (MethodBreakpoint.create (
  *        "examples.texteditor.Ted*",
- *        "
- *    ));
            
+ *        "<init>
+ *    ));
            * This breakpoint stops when some initializer of class Ted or innercalsses is * called. * diff --git a/java/api.debugger.jpda/src/org/netbeans/spi/debugger/jpda/SmartSteppingCallback.java b/java/api.debugger.jpda/src/org/netbeans/spi/debugger/jpda/SmartSteppingCallback.java index e905d02b272f..655eb29512c4 100644 --- a/java/api.debugger.jpda/src/org/netbeans/spi/debugger/jpda/SmartSteppingCallback.java +++ b/java/api.debugger.jpda/src/org/netbeans/spi/debugger/jpda/SmartSteppingCallback.java @@ -133,11 +133,11 @@ public static StopOrStep skip() { /** * Express the necessity to perform a step at the given location. * @param stepSize the step size, - * one of {@link #JPDAStep.STEP_LINE} or {@link #JPDAStep.STEP_MIN}, + * one of {@link JPDAStep#STEP_LINE} or {@link JPDAStep#STEP_MIN}, * or 0 for the default size. * @param stepDepth the step depth, - * one of {@link #JPDAStep.STEP_INTO}, {@link #JPDAStep.STEP_OVER}, - * {@link #JPDAStep.STEP_OUT}, or 0 for the default depth. + * one of {@link JPDAStep#STEP_INTO}, {@link JPDAStep#STEP_OVER}, + * {@link JPDAStep#STEP_OUT}, or 0 for the default depth. * @return the step information instance. * throws {@link IllegalArgumentException} when the size or depth is wrong. */ @@ -181,7 +181,7 @@ public boolean isStop() { /** * Get the step size. - * @return One of {@link #JPDAStep.STEP_LINE} or {@link #JPDAStep.STEP_MIN}, + * @return One of {@link JPDAStep#STEP_LINE} or {@link JPDAStep#STEP_MIN}, * or 0 for the default size. */ public int getStepSize() { @@ -190,8 +190,8 @@ public int getStepSize() { /** * Get the step depth. - * @return One of {@link #JPDAStep.STEP_INTO}, {@link #JPDAStep.STEP_OVER}, - * {@link #JPDAStep.STEP_OUT}, or 0 for the default depth. + * @return One of {@link JPDAStep#STEP_INTO}, {@link JPDAStep#STEP_OVER}, + * {@link JPDAStep#STEP_OUT}, or 0 for the default depth. */ public int getStepDepth() { return stepDepth; diff --git a/java/api.debugger.jpda/src/org/netbeans/spi/debugger/jpda/SourcePathProvider.java b/java/api.debugger.jpda/src/org/netbeans/spi/debugger/jpda/SourcePathProvider.java index c3b652526b9b..ffb05430264c 100644 --- a/java/api.debugger.jpda/src/org/netbeans/spi/debugger/jpda/SourcePathProvider.java +++ b/java/api.debugger.jpda/src/org/netbeans/spi/debugger/jpda/SourcePathProvider.java @@ -35,7 +35,7 @@ * ("file:///C:/Sources/java/lang/Thread.java"). It allows to define * and modify source path. * All instances of this class should be registerred in - * "Meta-inf/debugger//org.netbeans.spi.debugger.jpda.EngineContextProvider" + * "Meta-inf/debugger/<DebuggerEngine ID>/org.netbeans.spi.debugger.jpda.EngineContextProvider" * files. There should be at least one instance installed. * * @author Maros Sandor, Jan Jancura diff --git a/java/api.java/src/org/netbeans/api/java/queries/JavadocForBinaryQuery.java b/java/api.java/src/org/netbeans/api/java/queries/JavadocForBinaryQuery.java index 4f83757eef28..873ae8edbccf 100644 --- a/java/api.java/src/org/netbeans/api/java/queries/JavadocForBinaryQuery.java +++ b/java/api.java/src/org/netbeans/api/java/queries/JavadocForBinaryQuery.java @@ -91,8 +91,8 @@ public interface Result { /** * Get the Javadoc roots. * Each root should contain the main index.html, so that - * for a class pkg.Class the generated documentation would - * have a path pkg/Class.html relative to one of the roots. + * for a class pkg.Class the generated documentation would + * have a path pkg/Class.html relative to one of the roots. * @return array of roots of Javadoc documentation (may be empty but not null) */ URL[] getRoots(); diff --git a/java/api.java/src/org/netbeans/api/java/queries/SourceLevelQuery.java b/java/api.java/src/org/netbeans/api/java/queries/SourceLevelQuery.java index 3eff17662b2c..0ac63f641e68 100644 --- a/java/api.java/src/org/netbeans/api/java/queries/SourceLevelQuery.java +++ b/java/api.java/src/org/netbeans/api/java/queries/SourceLevelQuery.java @@ -128,7 +128,7 @@ public static String getSourceLevel(FileObject javaFile) { * javac compiler . * @param javaFile Java source file, Java package or source folder in question * @return a {@link Result} object encapsulating the source level of the Java file. Results created for source - * levels provided by the {@link SourceLevelQueryImplementation} do not support listening. Use {@link Result#supportsChanges()} + * levels provided by the {@link org.netbeans.spi.java.queries.SourceLevelQueryImplementation} do not support listening. Use {@link Result#supportsChanges()} * to check if the result supports listening. * @since 1.30 */ @@ -378,7 +378,7 @@ public void removeChangeListener(@NonNull ChangeListener listener) { * Returns true if the result support updates and client may * listen on it. If false client should always ask again to * obtain current value. The results created for values returned - * by the {@link SourceLevelQueryImplementation} do not support + * by the {@link org.netbeans.spi.java.queries.SourceLevelQueryImplementation} do not support * listening. * @return true if the result supports changes and listening */ diff --git a/java/api.java/src/org/netbeans/spi/java/queries/AccessibilityQueryImplementation.java b/java/api.java/src/org/netbeans/spi/java/queries/AccessibilityQueryImplementation.java index 7738e7979ff7..6c9f1bb279d5 100644 --- a/java/api.java/src/org/netbeans/spi/java/queries/AccessibilityQueryImplementation.java +++ b/java/api.java/src/org/netbeans/spi/java/queries/AccessibilityQueryImplementation.java @@ -35,8 +35,8 @@ * this query, if it depends on the Java Project module and uses this style. *

            * @see org.netbeans.api.java.queries.AccessibilityQuery - * @see org.netbeans.api.queries.FileOwnerQuery - * @see org.netbeans.api.project.Project#getLookup + * @see FileOwnerQuery + * @see Project#getLookup * @author Jesse Glick * @since org.netbeans.api.java/1 1.4 */ diff --git a/java/api.java/src/org/netbeans/spi/java/queries/AccessibilityQueryImplementation2.java b/java/api.java/src/org/netbeans/spi/java/queries/AccessibilityQueryImplementation2.java index 041add922cd7..5c0d8d4c4eb1 100644 --- a/java/api.java/src/org/netbeans/spi/java/queries/AccessibilityQueryImplementation2.java +++ b/java/api.java/src/org/netbeans/spi/java/queries/AccessibilityQueryImplementation2.java @@ -37,8 +37,8 @@ * this query, if it depends on the Java Project module and uses this style. *

            * @see org.netbeans.api.java.queries.AccessibilityQuery - * @see org.netbeans.api.queries.FileOwnerQuery - * @see org.netbeans.api.project.Project#getLookup + * @see FileOwnerQuery + * @see Project#getLookup * @author Tomas Zezula * @since 1.64 */ @@ -61,7 +61,7 @@ public interface AccessibilityQueryImplementation2 { interface Result { /** * Returns the accessibility. - * @return the {@link Accessibility} + * @return the {@link AccessibilityQuery.Accessibility} */ @NonNull AccessibilityQuery.Accessibility getAccessibility(); diff --git a/java/api.java/src/org/netbeans/spi/java/queries/JavadocForBinaryQueryImplementation.java b/java/api.java/src/org/netbeans/spi/java/queries/JavadocForBinaryQueryImplementation.java index bfc13acc78bb..cac60ed6b1db 100644 --- a/java/api.java/src/org/netbeans/spi/java/queries/JavadocForBinaryQueryImplementation.java +++ b/java/api.java/src/org/netbeans/spi/java/queries/JavadocForBinaryQueryImplementation.java @@ -33,7 +33,7 @@ * this query, if it depends on the Java Project module and uses this style. *

            * @see JavadocForBinaryQuery - * @see org.netbeans.api.project.Project#getLookup + * @see Project#getLookup * @author David Konecny, Jesse Glick * @since org.netbeans.api.java/1 1.4 */ @@ -45,7 +45,7 @@ public interface JavadocForBinaryQueryImplementation { *

            * Any absolute URL may be used but typically it will use the file * protocol for directory entries and jar protocol for JAR entries - * (e.g. jar:file:/tmp/foo.jar!/). + * (e.g. jar:file:/tmp/foo.jar!/). *

            *

            * {@link JavadocForBinaryQuery#findJavadoc} calls this method on instances registered diff --git a/java/api.java/src/org/netbeans/spi/java/queries/MultipleRootsUnitTestForSourceQueryImplementation.java b/java/api.java/src/org/netbeans/spi/java/queries/MultipleRootsUnitTestForSourceQueryImplementation.java index 7a201310eb0d..f3393a6f18b8 100644 --- a/java/api.java/src/org/netbeans/spi/java/queries/MultipleRootsUnitTestForSourceQueryImplementation.java +++ b/java/api.java/src/org/netbeans/spi/java/queries/MultipleRootsUnitTestForSourceQueryImplementation.java @@ -39,7 +39,7 @@ * is used for example for unit test generation and for searching test for * source. Usage of any other pattern will break this functionality.

            * - * @see Project.getLookup() + * @see Project.getLookup() * @see org.netbeans.api.java.queries.UnitTestForSourceQuery * @author Tomas Zezula * @since org.netbeans.api.java/1 1.7 diff --git a/java/api.java/src/org/netbeans/spi/java/queries/SourceJavadocAttacherImplementation.java b/java/api.java/src/org/netbeans/spi/java/queries/SourceJavadocAttacherImplementation.java index ad22ed57c7b1..16bc9a97f650 100644 --- a/java/api.java/src/org/netbeans/spi/java/queries/SourceJavadocAttacherImplementation.java +++ b/java/api.java/src/org/netbeans/spi/java/queries/SourceJavadocAttacherImplementation.java @@ -40,7 +40,7 @@ public interface SourceJavadocAttacherImplementation { /** * Attaches a source root provided by this SPI to given binary root. * @param root the binary root to attach sources to - * @param a listener notified about result when attaching is done + * @param listener a listener notified about result when attaching is done * @throws IOException in case of error */ boolean attachSources( @@ -50,7 +50,7 @@ boolean attachSources( /** * Attaches a javadoc root provided by this SPI to given binary root. * @param root the binary root to attach javadoc to - * @param a listener notified about result when attaching is done + * @param listener a listener notified about result when attaching is done * @throws IOException in case of error */ boolean attachJavadoc( diff --git a/java/api.java/src/org/netbeans/spi/java/queries/SourceLevelQueryImplementation2.java b/java/api.java/src/org/netbeans/spi/java/queries/SourceLevelQueryImplementation2.java index 275f925b0d2a..eec1e72863c8 100644 --- a/java/api.java/src/org/netbeans/spi/java/queries/SourceLevelQueryImplementation2.java +++ b/java/api.java/src/org/netbeans/spi/java/queries/SourceLevelQueryImplementation2.java @@ -38,8 +38,8 @@ * this query, if it depends on the Java Project module and uses this style. *

            * @see org.netbeans.api.java.queries.SourceLevelQuery - * @see org.netbeans.api.queries.FileOwnerQuery - * @see org.netbeans.api.project.Project#getLookup + * @see FileOwnerQuery + * @see Project#getLookup * @see org.netbeans.api.java.classpath.ClassPath#BOOT * @author Tomas Zezula * @since 1.30 diff --git a/java/api.java/src/org/netbeans/spi/java/queries/UnitTestForSourceQueryImplementation.java b/java/api.java/src/org/netbeans/spi/java/queries/UnitTestForSourceQueryImplementation.java index 61a8e3ae1b63..fa9d5df823c5 100644 --- a/java/api.java/src/org/netbeans/spi/java/queries/UnitTestForSourceQueryImplementation.java +++ b/java/api.java/src/org/netbeans/spi/java/queries/UnitTestForSourceQueryImplementation.java @@ -39,7 +39,7 @@ * is used for example for unit test generation and for searching test for * source. Usage of any other pattern will break this functionality.

            * - * @see Project.getLookup() + * @see Project.getLookup() * @see org.netbeans.api.java.queries.UnitTestForSourceQuery * @deprecated Use {@link org.netbeans.spi.java.queries.MultipleRootsUnitTestForSourceQueryImplementation} instead. * @author David Konecny diff --git a/platform/autoupdate.services/src/org/netbeans/api/autoupdate/InstallSupport.java b/platform/autoupdate.services/src/org/netbeans/api/autoupdate/InstallSupport.java index a6229753cc07..63c279e1061b 100644 --- a/platform/autoupdate.services/src/org/netbeans/api/autoupdate/InstallSupport.java +++ b/platform/autoupdate.services/src/org/netbeans/api/autoupdate/InstallSupport.java @@ -53,7 +53,7 @@ * support.doRestart(r, null); * } * - *

            + * * @author Radek Matous, Jiri Rechtacek */ public final class InstallSupport { diff --git a/platform/autoupdate.services/src/org/netbeans/api/autoupdate/OperationContainer.java b/platform/autoupdate.services/src/org/netbeans/api/autoupdate/OperationContainer.java index 58f1ebb91b3b..82991c6de508 100644 --- a/platform/autoupdate.services/src/org/netbeans/api/autoupdate/OperationContainer.java +++ b/platform/autoupdate.services/src/org/netbeans/api/autoupdate/OperationContainer.java @@ -59,7 +59,7 @@ * OperationSupport support = container.getSupport(); * support.doOperation(null); * - *

            + * * @param the type of support for performing chosen operation like * {@link OperationSupport} or {@link InstallSupport} * @author Radek Matous, Jiri Rechtacek diff --git a/platform/autoupdate.services/src/org/netbeans/spi/autoupdate/UpdateItem.java b/platform/autoupdate.services/src/org/netbeans/spi/autoupdate/UpdateItem.java index 2db170659422..5b62e556a8a2 100644 --- a/platform/autoupdate.services/src/org/netbeans/spi/autoupdate/UpdateItem.java +++ b/platform/autoupdate.services/src/org/netbeans/spi/autoupdate/UpdateItem.java @@ -50,8 +50,8 @@ public final class UpdateItem { item.setUpdateItem (this); } - /** Creates UpdateItem/code> which represents NetBeans Module in Autoupdate infrastructure. - * UpdateItem is identify by codeName and specificationVersion. + /** Creates UpdateItem which represents NetBeans Module in Autoupdate infrastructure. + * UpdateItem is identify by codeName and specificationVersion. * * @param codeName code name of module * @param specificationVersion specification version of module @@ -93,8 +93,8 @@ public static UpdateItem createModule ( return new UpdateItem (item); } - /** Creates UpdateItem/code> which represents NetBeans Module in Autoupdate infrastructure. - * UpdateItem is identify by codeName and specificationVersion. + /** Creates UpdateItem which represents NetBeans Module in Autoupdate infrastructure. + * UpdateItem is identify by codeName and specificationVersion. * * @param codeName code name of module * @param specificationVersion specification version of module @@ -141,8 +141,8 @@ public static UpdateItem createModule ( /** Creates UpdateItem which represents Feature, it's means group * of NetBeans Modules. This Feature is handled in UI as atomic item. - * UpdateItem is identify by codeName and specificationVersion. - *

            + * UpdateItem is identify by codeName and specificationVersion. + *

            * If some of the tokens in {@code dependencies} is not known, it will be reported * as a missing dependency. * diff --git a/platform/core.multiview/src/org/netbeans/core/spi/multiview/text/MultiViewEditorElement.java b/platform/core.multiview/src/org/netbeans/core/spi/multiview/text/MultiViewEditorElement.java index 3def348c5426..46274ba453c7 100644 --- a/platform/core.multiview/src/org/netbeans/core/spi/multiview/text/MultiViewEditorElement.java +++ b/platform/core.multiview/src/org/netbeans/core/spi/multiview/text/MultiViewEditorElement.java @@ -50,7 +50,7 @@ public static MultiViewEditorElement createEditor(Lookup lkp) { * to continue to call super implementation) and register the * subclass. * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> * @since 1.24 */ public class MultiViewEditorElement implements diff --git a/platform/core.netigso/src/org/netbeans/core/netigso/spi/BundleContent.java b/platform/core.netigso/src/org/netbeans/core/netigso/spi/BundleContent.java index c1c0b89bbee7..8a3035a234e3 100644 --- a/platform/core.netigso/src/org/netbeans/core/netigso/spi/BundleContent.java +++ b/platform/core.netigso/src/org/netbeans/core/netigso/spi/BundleContent.java @@ -24,7 +24,7 @@ /** Interface to represent anyone capable of providing real content from * a bundle. * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> * @since 1.3 */ public interface BundleContent { diff --git a/platform/core.netigso/src/org/netbeans/core/netigso/spi/NetigsoArchive.java b/platform/core.netigso/src/org/netbeans/core/netigso/spi/NetigsoArchive.java index 19625696d743..ce25ec0f2fcf 100644 --- a/platform/core.netigso/src/org/netbeans/core/netigso/spi/NetigsoArchive.java +++ b/platform/core.netigso/src/org/netbeans/core/netigso/spi/NetigsoArchive.java @@ -34,7 +34,7 @@ * an associated {@link BundleContent} implementation. Then you can read * cached content of your bundles via {@link #fromArchive(java.lang.String)}. * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> * @since 1.3 */ public final class NetigsoArchive { diff --git a/platform/core.startup/arch.xml b/platform/core.startup/arch.xml index 7a18ab718c92..befc2576e070 100644 --- a/platform/core.startup/arch.xml +++ b/platform/core.startup/arch.xml @@ -704,7 +704,7 @@ --> - +

            When present as a Java agent on the boot classpath, Javeleon is invoked reflectively to enhance module reloading.

            diff --git a/platform/core.startup/src/org/netbeans/core/startup/AutomaticDependencies.java b/platform/core.startup/src/org/netbeans/core/startup/AutomaticDependencies.java index 6038c03c2fa4..639e59fd9143 100644 --- a/platform/core.startup/src/org/netbeans/core/startup/AutomaticDependencies.java +++ b/platform/core.startup/src/org/netbeans/core/startup/AutomaticDependencies.java @@ -58,8 +58,8 @@ * Public for possible access from AU (see #29577). * Usage: see implementation of {@link ModuleInstaller#refineDependencies}. * @author Jesse Glick, with help from NB XML module - * @see "#30161" - * @see -//NetBeans//DTD Module Automatic Dependencies 1.0//EN + * @see 30161 + * @see -//NetBeans//DTD Module Automatic Dependencies 1.0//EN * @since org.netbeans.core/1 1.12 */ public final class AutomaticDependencies { @@ -119,8 +119,8 @@ public static AutomaticDependencies getDefault() { /** * Create a list of transformations based on some XML files. * They must be valid (this method may not validate them). - * Doctype must be <transformations> from - * -//NetBeans//DTD Module Automatic Dependencies 1.0//EN. + * Doctype must be <transformations> from + * -//NetBeans//DTD Module Automatic Dependencies 1.0//EN. * @param urls the XML files * @throws SAXException if malformed * @throws IOException if unloadable diff --git a/platform/core.startup/src/org/netbeans/core/startup/MainLookup.java b/platform/core.startup/src/org/netbeans/core/startup/MainLookup.java index 148a16284adf..9b32d10f678c 100644 --- a/platform/core.startup/src/org/netbeans/core/startup/MainLookup.java +++ b/platform/core.startup/src/org/netbeans/core/startup/MainLookup.java @@ -107,8 +107,8 @@ public static final void moduleClassLoadersUp() { l.changeLookups(newDelegates); } - /** Called when Lookup is ready from the ModuleManager. - * @see "#28465" + /** Called when Lookup<ModuleInfo> is ready from the ModuleManager. + * @see 28465 */ public static final void moduleLookupReady(Lookup moduleLookup) { if (Lookup.getDefault() instanceof MainLookup) { diff --git a/platform/core.startup/src/org/netbeans/core/startup/ModuleLifecycleManager.java b/platform/core.startup/src/org/netbeans/core/startup/ModuleLifecycleManager.java index 1e65d5b16dda..e30cfdcc4698 100644 --- a/platform/core.startup/src/org/netbeans/core/startup/ModuleLifecycleManager.java +++ b/platform/core.startup/src/org/netbeans/core/startup/ModuleLifecycleManager.java @@ -33,7 +33,7 @@ /** * Rudimentary manager useful for non-GUI platform applications. * Superseded by NbLifecycleManager. - * @see #158525 + * @see 158525 */ @ServiceProvider(service=LifecycleManager.class) public class ModuleLifecycleManager extends LifecycleManager { diff --git a/platform/core.startup/src/org/netbeans/core/startup/NbPlaces.java b/platform/core.startup/src/org/netbeans/core/startup/NbPlaces.java index 42e80574d2b0..8fc54751bbd7 100644 --- a/platform/core.startup/src/org/netbeans/core/startup/NbPlaces.java +++ b/platform/core.startup/src/org/netbeans/core/startup/NbPlaces.java @@ -24,7 +24,7 @@ /** Implementation of Places to deal with command line --cachedir argument. * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> */ @ServiceProvider(service=Places.class) public final class NbPlaces extends Places { diff --git a/platform/core.startup/src/org/netbeans/core/startup/layers/LayerCacheManager.java b/platform/core.startup/src/org/netbeans/core/startup/layers/LayerCacheManager.java index b2914fd08325..ee12902c3d02 100644 --- a/platform/core.startup/src/org/netbeans/core/startup/layers/LayerCacheManager.java +++ b/platform/core.startup/src/org/netbeans/core/startup/layers/LayerCacheManager.java @@ -46,7 +46,7 @@ import org.openide.util.NbBundle; /** Interface for a manager which can handle XML layer caching. - * @see "#20168" + * @see 20168 * @author Jesse Glick */ public abstract class LayerCacheManager implements LayerFactory { @@ -195,7 +195,7 @@ public List additionalLayers(List urls) { * Should only be called when the cache directory is prepared. * The filesystem's contents should be modified. * The filesystem must have been originally produced by - * {@link #createEmptyFileSystem} or {@link #createLoadedFileSystem}. + * {@link #createEmptyFileSystem}. * Not called if the manager does not support loading; * otherwise must be overridden. */ @@ -204,7 +204,6 @@ public List additionalLayers(List urls) { /** * Save a new cache to disk, load it, and return that filesystem. * @param urls list of type URL; earlier layers can override later layers - * @return a new filesystem with the specified contents * Not called if the manager supports loading; * otherwise must be overridden. */ diff --git a/platform/core.startup/src/org/netbeans/core/startup/layers/SessionManager.java b/platform/core.startup/src/org/netbeans/core/startup/layers/SessionManager.java index 4aee208558e9..6e60f24a75ba 100644 --- a/platform/core.startup/src/org/netbeans/core/startup/layers/SessionManager.java +++ b/platform/core.startup/src/org/netbeans/core/startup/layers/SessionManager.java @@ -71,7 +71,7 @@ public static SessionManager getDefault() { * @param homeDir directory where netbeans has been installed, user need not have write access * @param extradirs 0+ extra dirs to add; cf. #27151 * @return repository - * @exception PropertyVetoException if something fails + * @exception java.beans.PropertyVetoException if something fails */ public FileSystem create(File userDir, File homeDir, File[] extradirs) throws java.beans.PropertyVetoException, IOException { @@ -89,7 +89,7 @@ public void close() { /** get a layer associated with the name * @param name layer name (LAYER_SESSION, ...) - * @return layer, can be null + * @return layer, can be null */ public FileSystem getLayer(String name) { return layers.get(name); diff --git a/platform/core.startup/src/org/netbeans/core/startup/package.html b/platform/core.startup/src/org/netbeans/core/startup/package.html index cd4085d93834..b22c02f6c237 100644 --- a/platform/core.startup/src/org/netbeans/core/startup/package.html +++ b/platform/core.startup/src/org/netbeans/core/startup/package.html @@ -84,7 +84,7 @@

            {@link org.netbeans.core.modules.TestModuleDeployer} is a service available via lookup which deploys test modules; accessible separately with a thin API for use by modules such as the API Support. -

            {@link AutomaticDependencies} is used to parse XML files constrained by module-auto-deps-1_0.dtd +

            {@link org.netbeans.core.stratup.AutomaticDependencies} is used to parse XML files constrained by module-auto-deps-1_0.dtd and automatically update dependencies used by old modules as a result. This is very useful for maintaining backward compatibility across major refactorings.

            Also of interest: {@link org.netbeans.core.ui.ModuleBean} provides a Swing-safe UI diff --git a/platform/o.n.bootstrap/arch.xml b/platform/o.n.bootstrap/arch.xml index 4ca45f70c065..87508d9d2907 100644 --- a/platform/o.n.bootstrap/arch.xml +++ b/platform/o.n.bootstrap/arch.xml @@ -190,7 +190,7 @@ group="java.io.File" name="nbexec" type="export" - url="http://platform.netbeans.org/articles/installation.html#launcher" + url="https://netbeans.apache.org/projects/platform/articles/installation.html#launcher" /> launcher is fully featured and supported. It should work on any Unix flavor. Implemented as a shell script. @@ -215,7 +215,7 @@ group="java.io.File" name="nbexec.exe" type="export" - url="http://platform.netbeans.org/articles/installation.html#launcher" + url="https://netbeans.apache.org/projects/platform/articles/installation.html#launcher" /> launcher is fully featured and supported. As part of core. But not on + href="https://bz.apache.org/netbeans/show_bug.cgi?id=24361">not on Windows. @@ -477,7 +477,7 @@

          • Additional secondary NetBeans installation directories as proposed in installation structure + href="https://netbeans.apache.org/projects/platform/articles/installation.html">installation structure design document.
            • @@ -684,7 +684,7 @@
          • Specify base fontsize. Deprecated in favor of using themes + href="https://netbeans.apache.org/projects/ui/themes/themes.html">themes which is much more general. But this is a convenient quick settings, handy for projection screens and so on. @@ -759,7 +759,7 @@ load from JARs is rather buggy when it comes to changing or removing the JAR during the JVM session.

            - +

            When present as a Java agent on the boot classpath, Javeleon is invoked reflectively to enhance module reloading.

             @@ -1410,7 +1410,7 @@

            NetBeans Module system is optimized to eliminate useless I/O - operations on start (as a result the + operations on start (as a result the embedded OSGi container is fastest on the planet -- with respect to application start up time). This is achieved by caching information known to have been needed in previous starts and using it @@ -1427,7 +1427,7 @@ Together, working in orchestration, they eliminate the need to touch the disk (which is very slow operation especially during morning launch). - Btw. there is a + Btw. there is a test which verifies the caching system really works -- it is recommended for each product built on top of NetBeans Platform diff --git a/platform/o.n.bootstrap/src/org/netbeans/CLIHandler.java b/platform/o.n.bootstrap/src/org/netbeans/CLIHandler.java index 5e2bf4a7fbf5..20817f8ed285 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/CLIHandler.java +++ b/platform/o.n.bootstrap/src/org/netbeans/CLIHandler.java @@ -55,12 +55,12 @@ * Command Line Interface and User Directory Locker support class. * Subclasses may be registered into the system to handle special command-line options. * To be registered, use {@link org.openide.util.lookup.ServiceProvider} - * in a JAR file in the startup or dynamic class path (e.g. lib/ext/ - * or lib/). + * in a JAR file in the startup or dynamic class path (e.g. lib/ext/ + * or lib/). * @author Jaroslav Tulach * @since org.netbeans.core/1 1.18 * @see "#32054" - * @see Specification + * @see Specification */ public abstract class CLIHandler extends Object { /** lenght of the key used for connecting */ diff --git a/platform/o.n.bootstrap/src/org/netbeans/Events.java b/platform/o.n.bootstrap/src/org/netbeans/Events.java index b3932f4891a8..ba531218284c 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/Events.java +++ b/platform/o.n.bootstrap/src/org/netbeans/Events.java @@ -59,23 +59,23 @@ public abstract class Events { public static final String FINISH_DEPLOY_TEST_MODULE = "finishDeployTestModule"; // NOI18N /** Module toDelete */ public static final String DELETE_MODULE = "deleteModule"; // NOI18N - /** List toEnable */ + /** List<Module> toEnable */ public static final String START_ENABLE_MODULES = "startEnableModules"; // NOI18N - /** List toEnable */ + /** List<Module> toEnable */ public static final String FINISH_ENABLE_MODULES = "finishEnableModules"; // NOI18N - /** List toDisable */ + /** List<Module> toDisable */ public static final String START_DISABLE_MODULES = "startDisableModules"; // NOI18N - /** List toDisable */ + /** List<Module> toDisable */ public static final String FINISH_DISABLE_MODULES = "finishDisableModules"; // NOI18N /** Module prepared */ public static final String PREPARE = "prepare"; // NOI18N - /** List loaded */ + /** List<Module> loaded */ public static final String START_LOAD = "startLoad"; // NOI18N - /** List loaded */ + /** List<Module> loaded */ public static final String FINISH_LOAD = "finishLoad"; // NOI18N - /** List unloaded */ + /** List<Module> unloaded */ public static final String START_UNLOAD = "startUnload"; // NOI18N - /** List unloaded */ + /** List<Module> unloaded */ public static final String FINISH_UNLOAD = "finishUnload"; // NOI18N /** Module installed */ public static final String INSTALL = "install"; // NOI18N @@ -91,27 +91,27 @@ public abstract class Events { public static final String CLOSE = "close"; // NOI18N /** no args */ public static final String START_READ = "startRead"; // NOI18N - /** Set found */ + /** Set<Module> found */ public static final String FINISH_READ = "finishRead"; // NOI18N /** FileObject */ public static final String MODULES_FILE_PROCESSED = "modulesFileProcessed"; // NOI18N /** Integer */ public static final String MODULES_FILE_SCANNED = "modulesFileScanned"; // NOI18N - /** Set toInstall */ + /** Set<Module> toInstall */ public static final String START_AUTO_RESTORE = "startAutoRestore"; // NOI18N - /** Set toInstall */ + /** Set<Module> toInstall */ public static final String FINISH_AUTO_RESTORE = "finishAutoRestore"; // NOI18N - /** Set notInstalled */ + /** Set<Module> notInstalled */ public static final String FAILED_INSTALL_NEW = "failedInstallNew"; // NOI18N /** Module notInstalled, InvalidException problem */ public static final String FAILED_INSTALL_NEW_UNEXPECTED = "failedInstallNewUnexpected"; // NOI18N - /** Set modules */ + /** Set<Module> modules */ public static final String LOAD_LAYERS = "loadLayers"; // NOI18N - /** Set modules */ + /** Set<Module> modules */ public static final String UNLOAD_LAYERS = "unloadLayers"; // NOI18N /** Module culprit, Class offending, ClassLoader expected */ public static final String WRONG_CLASS_LOADER = "wrongClassLoader"; // NOI18N - /** File extension, Set owners */ + /** File extension, Set<File>owners */ public static final String EXTENSION_MULTIPLY_LOADED = "extensionMultiplyLoaded"; // NOI18N /** File nonexistentJar */ public static final String MISSING_JAR_FILE = "missingJarFile"; // NOI18N diff --git a/platform/o.n.bootstrap/src/org/netbeans/Module.java b/platform/o.n.bootstrap/src/org/netbeans/Module.java index 45dffce20766..ff81bba3e10a 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/Module.java +++ b/platform/o.n.bootstrap/src/org/netbeans/Module.java @@ -63,7 +63,7 @@ public abstract class Module extends ModuleInfo { /** event logging (should not be much here) */ protected final Events events; /** associated history object - * @see ModuleHistory + * @see ModuleHistory */ private final Object history; /** true if currently enabled; manipulated by ModuleManager */ @@ -203,7 +203,7 @@ public boolean isValid() { * permanently beyond the existence of its JAR file; * it is enabled when some real module needs it to be, * and disabled when this is no longer the case. - * @see #9779 + * @see #9779 */ public boolean isAutoload() { return autoload; @@ -215,7 +215,7 @@ public boolean isAutoload() { * its dependencies. This may be used to implement "bridge" modules with * simple functionality that just depend on two normal modules. * A module may not be simultaneously eager and autoload. - * @see #17501 + * @see #17501 * @since org.netbeans.core/1 1.3 */ public boolean isEager() { @@ -440,7 +440,7 @@ public boolean isReloadable() { /** Turn off the classloader and release all resources. */ protected abstract void classLoaderDown(); - /** Should be called after turning off the classloader of one or more modules & GC'ing. */ + /** Should be called after turning off the classloader of one or more modules & GC'ing. */ protected abstract void cleanup(); /** Notify the module that it is being deleted. */ @@ -520,7 +520,7 @@ final void firePropertyChange0(String prop, Object old, Object nue) { } /** Get the history object representing what has happened to this module before. - * @see org.netbeans.core.startup.ModuleHistory + * @see ModuleHistory */ public final Object getHistory() { return history; @@ -619,7 +619,7 @@ void releaseClassLoader() { * @see Module#getPublicPackages */ public static final class PackageExport { - /** Package to export, in the form org/netbeans/modules/foo/. */ + /** Package to export, in the form org/netbeans/modules/foo/. */ public final String pkg; /** If true, export subpackages also. */ public final boolean recursive; diff --git a/platform/o.n.bootstrap/src/org/netbeans/ModuleManager.java b/platform/o.n.bootstrap/src/org/netbeans/ModuleManager.java index 3e15e512ee4b..c3cb44a2ac71 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/ModuleManager.java +++ b/platform/o.n.bootstrap/src/org/netbeans/ModuleManager.java @@ -954,7 +954,7 @@ public boolean shouldDelegateResource(Module m, Module parent, String pkg) { * `parent'. The parent is identified either by module specification (parent) or by a classloader * which should load the package. For system or bootstrap classes, `parent' may be {@code null}, since * boostrap classloaders load more modules together. - *

            + *

            * If both `parent' and `ldr' are {@code null}, access to system/application classpath will be checked. * * @param m module that attempts to load resources. @@ -1130,7 +1130,7 @@ private boolean registerModuleFragment(Module m) { * Removes a fragment module. Throws an exception if the fragment's * host is already enabled and its classloader may have loaded fragment's * contents. - *

            + *

            * The method does nothing for non-fragment modules * * @param m the module to remove diff --git a/platform/o.n.bootstrap/src/org/netbeans/NetigsoFramework.java b/platform/o.n.bootstrap/src/org/netbeans/NetigsoFramework.java index b03a22f22bc3..21802afe6175 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/NetigsoFramework.java +++ b/platform/o.n.bootstrap/src/org/netbeans/NetigsoFramework.java @@ -35,7 +35,7 @@ /** This class contains abstracted calls to OSGi provided by core.netigso * module. No other module can implement this class, except core.netigso. * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> */ public abstract class NetigsoFramework { private ModuleManager mgr; @@ -135,7 +135,7 @@ protected int defaultStartLevel() { // /** Get an array of bytes from archive. If not found, it remembers the - * request and later calls {@link #toArchive(java.lang.String, java.lang.String)} + * request and later calls #toArchive(java.lang.String, java.lang.String) * method to store it for next time. * * @param name name of the resource inside the JAR @@ -170,7 +170,7 @@ protected final Module findModule(String cnb) { /** Gives OSGi support access to NetBeans bytecode manipulation libraries. * They are built over {@link Instrumentation} specification - * read more at + * read more at * architecture document. * * @param l the classloader that is loading the class diff --git a/platform/o.n.bootstrap/src/org/netbeans/PatchByteCode.java b/platform/o.n.bootstrap/src/org/netbeans/PatchByteCode.java index 074d8a776d6d..0da835190aad 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/PatchByteCode.java +++ b/platform/o.n.bootstrap/src/org/netbeans/PatchByteCode.java @@ -163,7 +163,7 @@ private Method patchAsmMethod(ClassLoader l) throws NoSuchMethodException, Secur } /** * Patches a class if it is needed. - * @param arr the bytecode + * @param data the bytecode * @return the enhanced bytecode */ public static byte[] patch(byte[] data) { diff --git a/platform/o.n.bootstrap/src/org/netbeans/ProxyClassLoader.java b/platform/o.n.bootstrap/src/org/netbeans/ProxyClassLoader.java index e64180db7c9b..0f72833888fe 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/ProxyClassLoader.java +++ b/platform/o.n.bootstrap/src/org/netbeans/ProxyClassLoader.java @@ -106,7 +106,7 @@ public void append(ClassLoader[] nueparents) throws IllegalArgumentException { /** * Loads the class with the specified name. The implementation of - * this method searches for classes in the following order:

            + * this method searches for classes in the following order: *

              *
            1. Looks for a known package and pass the loading to the ClassLoader for that package. @@ -450,7 +450,6 @@ protected Package getPackage(String name) { /** * Faster way to find a package. * @param name package name in org.netbeans.modules.foo format - * @param sname package name in org/netbeans/modules/foo/ format * @param recurse whether to also ask parents * @return located package, or null */ diff --git a/platform/o.n.bootstrap/src/org/netbeans/Stamps.java b/platform/o.n.bootstrap/src/org/netbeans/Stamps.java index 7e8ec50cc2b7..f274d5d0abfa 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/Stamps.java +++ b/platform/o.n.bootstrap/src/org/netbeans/Stamps.java @@ -62,7 +62,7 @@ * Support for optimal checking of time stamps of certain files in * NetBeans directory structure. * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jaroslav.tulach@netbeans.org> * @since 2.9 */ public final class Stamps { @@ -133,7 +133,7 @@ public boolean exists(String cache) { } /** Opens the access to cache object as a stream. - * @param name name of the cache + * @param cache name of the cache * @return stream to read from the cache or null if the cache is not valid */ public InputStream asStream(String cache) { @@ -157,7 +157,7 @@ public MappedByteBuffer asMappedByteBuffer(String cache) { */ /** Opens the access to cache object as a stream. - * @param name name of the cache + * @param cache name of the cache * @return stream to read from the cache or null if the cache is not valid */ public ByteBuffer asByteBuffer(String cache) { @@ -213,7 +213,7 @@ private ByteBuffer asByteBuffer(String cache, boolean direct, boolean mmap) { /** Method for registering updates to caches. * @param updater the callback to start when flushing caches - * @param file name of the file to store the cache into + * @param cache name of the file to store the cache into * @param append write from scratch or append? */ public void scheduleSave(Updater updater, String cache, boolean append) { diff --git a/platform/o.n.bootstrap/src/org/netbeans/StandardModule.java b/platform/o.n.bootstrap/src/org/netbeans/StandardModule.java index 52ab00b69712..e52466142fe8 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/StandardModule.java +++ b/platform/o.n.bootstrap/src/org/netbeans/StandardModule.java @@ -334,7 +334,7 @@ private Set findPatches() { * as needed. * Note: due to #19698, this cache is not usually used; only if you * specifically go to look at the display properties of a disabled module. - * @see #12549 + * @see #12549 */ private void loadLocalizedProps(JarFile jarFile, Manifest m) throws IOException { String locbundle = m.getMainAttributes().getValue("OpenIDE-Module-Localizing-Bundle"); // NOI18N @@ -557,7 +557,7 @@ protected void classLoaderDown() { } classloader = null; } - /** Should be called after turning off the classloader of one or more modules & GC'ing. */ + /** Should be called after turning off the classloader of one or more modules & GC'ing. */ protected void cleanup() { if (isEnabled()) throw new IllegalStateException("cleanup on enabled module: " + this); // NOI18N if (classloader != null) throw new IllegalStateException("cleanup on module with classloader: " + this); // NOI18N diff --git a/platform/o.n.bootstrap/src/org/netbeans/Util.java b/platform/o.n.bootstrap/src/org/netbeans/Util.java index 395de6062851..2287d871442d 100644 --- a/platform/o.n.bootstrap/src/org/netbeans/Util.java +++ b/platform/o.n.bootstrap/src/org/netbeans/Util.java @@ -232,7 +232,7 @@ public interface ModuleProvider { * list of modules (suitable for disabling; reverse for enabling). * @param modules some modules * @param modulesByName map from module cnbs to modules (may contain unrelated modules) - * @param providersOf map from tokens to sets of modules providing them (may mention unrelated modules) + * @param _providersOf map from tokens to sets of modules providing them (may mention unrelated modules) * @return a map from modules to lists of modules they depend on * @see Utilities#topologicalSort * JST-PENDING needed from tests diff --git a/platform/o.n.core/src/org/netbeans/beaninfo/editors/ArrayOfIntSupport.java b/platform/o.n.core/src/org/netbeans/beaninfo/editors/ArrayOfIntSupport.java index f22dde281cbc..a10c13ff5fce 100644 --- a/platform/o.n.core/src/org/netbeans/beaninfo/editors/ArrayOfIntSupport.java +++ b/platform/o.n.core/src/org/netbeans/beaninfo/editors/ArrayOfIntSupport.java @@ -211,7 +211,7 @@ String getHintFormat() { * the value should be available via the getValue method. * An IOException should be thrown when the value cannot be restored from the specified XML element * @param element the XML DOM element representing a subtree of XML from which the value should be loaded - * @exception IOException thrown when the value cannot be restored from the specified XML element + * @exception java.io.IOException thrown when the value cannot be restored from the specified XML element */ public void readFromXML (org.w3c.dom.Node element) throws java.io.IOException { if (!getXMLValueTag ().equals (element.getNodeName ())) { diff --git a/platform/o.n.core/src/org/netbeans/beaninfo/editors/CharEditor.java b/platform/o.n.core/src/org/netbeans/beaninfo/editors/CharEditor.java index 47292ea50570..c09bf40c421e 100644 --- a/platform/o.n.core/src/org/netbeans/beaninfo/editors/CharEditor.java +++ b/platform/o.n.core/src/org/netbeans/beaninfo/editors/CharEditor.java @@ -107,7 +107,7 @@ public void setAsText(String text) throws IllegalArgumentException { /** * Accepts Character and String values. If the argument is * a String the first character is taken as the new value. - * @param v new value + * @param newValue new value */ @Override public void setValue(Object newValue) throws IllegalArgumentException { diff --git a/platform/o.n.core/src/org/netbeans/beaninfo/editors/ColorEditor.java b/platform/o.n.core/src/org/netbeans/beaninfo/editors/ColorEditor.java index a0f03205e72c..7358ec671e06 100644 --- a/platform/o.n.core/src/org/netbeans/beaninfo/editors/ColorEditor.java +++ b/platform/o.n.core/src/org/netbeans/beaninfo/editors/ColorEditor.java @@ -225,7 +225,7 @@ public Object getValue () { /** Sets value. Implements PropertyEditor interface. * @param object object to set, accepts Color - * or SuperColor types */ + * or SuperColor types */ public void setValue (Object object) { if(object != null) { if (object instanceof SuperColor) { diff --git a/platform/o.n.core/src/org/netbeans/beaninfo/editors/IntEditor.java b/platform/o.n.core/src/org/netbeans/beaninfo/editors/IntEditor.java index 6eda57de8db5..9f0914719325 100644 --- a/platform/o.n.core/src/org/netbeans/beaninfo/editors/IntEditor.java +++ b/platform/o.n.core/src/org/netbeans/beaninfo/editors/IntEditor.java @@ -33,12 +33,14 @@ * values and handles whitespace in setAsText better than the default * JDK one. The following hints are supported: *
              • stringKeys - an array of Strings that should be supplied - * from getTags()
              • intValues - an array of ints corresponding to + * from getTags()
              • intValues - an array of ints corresponding to * the values represented by stringKeys. This hint must be present if - * the stringKeys hint is used, and the arrays must be of the same length.
                • + * the stringKeys hint is used, and the arrays must be of the same length. *
              • codeValues - an array of strings that should be returned from * getJavaInitializationString. This hint is optional when using the - * aforementioned hints.

                These hints will also work for the Integer + * aforementioned hints. + *

              + *

              These hints will also work for the Integer * editor, which wraps an instance of this editor. * * @author Tim Boudreau diff --git a/platform/o.n.core/src/org/netbeans/beaninfo/editors/StringArrayEditor.java b/platform/o.n.core/src/org/netbeans/beaninfo/editors/StringArrayEditor.java index 1aeb0f70daa2..417f7f7a3b36 100644 --- a/platform/o.n.core/src/org/netbeans/beaninfo/editors/StringArrayEditor.java +++ b/platform/o.n.core/src/org/netbeans/beaninfo/editors/StringArrayEditor.java @@ -197,7 +197,7 @@ public org.w3c.dom.Node storeToXML(org.w3c.dom.Document doc) { * the specified XML element * @param element the XML DOM element representing a subtree of XML from * which the value should be loaded - * @exception IOException thrown when the value cannot be restored from + * @exception java.io.IOException thrown when the value cannot be restored from the specified XML element */ public void readFromXML(org.w3c.dom.Node element) throws java.io.IOException { diff --git a/platform/o.n.core/src/org/netbeans/beaninfo/editors/URLEditor.java b/platform/o.n.core/src/org/netbeans/beaninfo/editors/URLEditor.java index 3a516e8de32c..735908a4f524 100644 --- a/platform/o.n.core/src/org/netbeans/beaninfo/editors/URLEditor.java +++ b/platform/o.n.core/src/org/netbeans/beaninfo/editors/URLEditor.java @@ -83,7 +83,7 @@ public boolean supportsCustomEditor () { * the value should be available via the getValue method. * An IOException should be thrown when the value cannot be restored from the specified XML element * @param element the XML DOM element representing a subtree of XML from which the value should be loaded - * @exception IOException thrown when the value cannot be restored from the specified XML element + * @exception java.io.IOException thrown when the value cannot be restored from the specified XML element */ public void readFromXML (org.w3c.dom.Node element) throws java.io.IOException { if (!XML_URL.equals (element.getNodeName ())) { diff --git a/platform/o.n.core/src/org/netbeans/core/Services.java b/platform/o.n.core/src/org/netbeans/core/Services.java index 42e2b313bd86..2540c397028c 100644 --- a/platform/o.n.core/src/org/netbeans/core/Services.java +++ b/platform/o.n.core/src/org/netbeans/core/Services.java @@ -130,7 +130,7 @@ public java.util.List getServiceTypes () { * instaces of the objects but only of the types that are already registered * to the system by manifest sections. * - * @param arr list of ServiceTypes + * @param arr0 list of ServiceTypes */ public synchronized void setServiceTypes (java.util.List/**/ arr0) { if (arr0 == null) { diff --git a/platform/o.n.core/src/org/netbeans/core/actions/LogViewerSupport.java b/platform/o.n.core/src/org/netbeans/core/actions/LogViewerSupport.java index 56b51b9d040b..b523069a54ab 100644 --- a/platform/o.n.core/src/org/netbeans/core/actions/LogViewerSupport.java +++ b/platform/o.n.core/src/org/netbeans/core/actions/LogViewerSupport.java @@ -49,7 +49,7 @@ public class LogViewerSupport implements Runnable { /** Connects a given process to the output window. Returns immediately, but threads are started that * copy streams of the process to/from the output window. - * @param process process whose streams to connect to the output window + * @param fileName process whose streams to connect to the output window * @param ioName name of the output window tab to use */ public LogViewerSupport(final File fileName, final String ioName) { diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTable.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTable.java index 627e21b6d7c3..48158bfe572b 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTable.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTable.java @@ -313,7 +313,7 @@ private static Graphics2D getOffscreenGraphics() { /** * Overridden to calculate a preferred size based on the current optimal * number of columns, and set up the preferred width for each column based - * on the maximum width item & icon displayed in it + * on the maximum width item & icon displayed in it */ @Override public Dimension getPreferredSize() { diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTableItem.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTableItem.java index 25fbb3dd0525..afcf7a083ca0 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTableItem.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTableItem.java @@ -22,7 +22,7 @@ import javax.swing.Icon; /** - * Represents one item in SwitcherTable. + * Represents one item in SwitcherTable. * * @see SwitcherTable * @@ -100,7 +100,7 @@ public String getHtmlName() { /** * Return item's description - the text which can be used for arbitrary - * purpose. E.g. KeyboardPopupSwitcher uses it for statusbar + * purpose. E.g. KeyboardPopupSwitcher uses it for statusbar * text. */ public String getDescription() { diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTableModel.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTableModel.java index a735f244d805..5f5756606bd1 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTableModel.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/popupswitcher/SwitcherTableModel.java @@ -24,7 +24,7 @@ import org.openide.util.Utilities; /** - * TableModel for SwitcherTable. + * TableModel for SwitcherTable. * * @see SwitcherTable * diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabData.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabData.java index 57f2e8278d06..c8d63cd6f72e 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabData.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabData.java @@ -31,7 +31,7 @@ * immutable to client code, changes to the data model may change the values * returned by the methods of this class. TabData objects are the data * component of TabDataModel. - *

              + *

              * TabData objects implement their equals() and * hashCode contract based on the equality of the user object and * the text. The icon and the tooltip text are not considered when testing diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabDataModel.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabDataModel.java index 7e2f7ffc369e..3e1deabd5d94 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabDataModel.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabDataModel.java @@ -208,7 +208,7 @@ public interface TabDataModel { * The model will fire a change event whenever a modification occurs that * could require a repaint. This method is only here for the * prototype - eventually the UI delegate should listen for ComplexDataNN - * events and optimize repaints based on the actual areas affected. + * events and optimize repaints based on the actual areas affected. */ public void addChangeListener(ChangeListener listener); @@ -216,7 +216,7 @@ public interface TabDataModel { * The model will fire a change event whenever a modification occurs that * could require a repaint. This method is only here for the * prototype - eventually the UI delegate should listen for ComplexDataNN - * events and optimize repaints based on the actual areas affected. + * events and optimize repaints based on the actual areas affected. */ public void removeChangeListener(ChangeListener listener); } diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabbedContainer.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabbedContainer.java index e531508a3205..63aa5c8a378c 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabbedContainer.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/TabbedContainer.java @@ -75,13 +75,16 @@ * fade or sliding effect when displayed. For this style, a second click on the selected * tab will hide the selected tab (setting the selection model's selected index to -1).

          *

          - *

          Customizing the appearance of tabs

          + * Customizing the appearance of tabs + *

          * Tabs are customized by providing a different UI delegate for the tab displayer component, * via UIManager, in the same manner as any standard Swing component; for TYPE_SLIDING * tabs, simply implementing an alternate UI delegate for the buttons used to represent tabs * is all that is needed. * - *

          Managing user events on tabs

          + *

          + * Managing user events on tabs + *

          * When a user clicks a tab, the TabbedContainer will fire an action event to all of its listeners. * This action event will always be an instance of TabActionEvent, which can provide * the index of the tab that was pressed, and the command name of the action that was performed. @@ -89,7 +92,9 @@ * to save data, and possibly vetoing the closing of a tab) may veto (or take full responsibility * for performing) the action by consuming the TabActionEvent. * - *

          Indication of focus and the "activated" state

          + *

          + * Indication of focus and the "activated" state + *

          * The property active is provided to allow a tabbed container to indicate that it * contains the currently focused component. However, no effort is made to track focus on the * part of the tabbed control - there is too much variability possible (for example, if @@ -571,7 +576,7 @@ public int tabForCoordinate (Point p) { * TabbedContainer. While one would expect a component gaining keyboard * focus to be a good determinant, it actually turns out to be a potent * source of subtle and hard-to-fix bugs. - *

          + *

          * NetBeans uses an AWTEventListener to track mouse clicks, and allows * components to become activated only via a mouse click or via a keyboard * action or menu item which activates the component. This approach is far diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/customtabs/Tabbed.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/customtabs/Tabbed.java index 248de8ebaa55..d6c3bff79ae0 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/customtabs/Tabbed.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/customtabs/Tabbed.java @@ -50,7 +50,7 @@ public abstract class Tabbed { /** * Turn tab highlight on/off - * @param tab + * @param tc * @since 1.38 */ public void setAttentionHighlight(TopComponent tc, boolean highlight) { diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/event/ArrayDiff.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/event/ArrayDiff.java index 12c20f4ffbd0..14f61532a75d 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/event/ArrayDiff.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/event/ArrayDiff.java @@ -33,7 +33,6 @@ * Class representing a diff of two arrays. Note that it is * not designed to work with arrays which contain the same * element more than one time - in that case, the results are undefined. - *

          *

          Note the current implementation is unoptimized and fairly brute force. * * @author Tim Boudreau diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/AbstractViewTabDisplayerUI.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/AbstractViewTabDisplayerUI.java index 41f045ed2405..80ef0335cf8e 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/AbstractViewTabDisplayerUI.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/AbstractViewTabDisplayerUI.java @@ -69,7 +69,7 @@ /** * Basic UI class for view tabs - non scrollable tabbed displayer, which shows all * tabs equally sized, proportionally. This class is independent on specific - * L&F, acts as base class for specific L&F descendants. + * L&F, acts as base class for specific L&F descendants. *

          * XXX eventually this class should be deleted and a subclass of BasicTabDisplayer can be used; * currently this is simply a port of the original code to the new API. Do not introduce any new diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/BusyTabsSupport.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/BusyTabsSupport.java index 3325bcdccd22..b68bc6d7053a 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/BusyTabsSupport.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/BusyTabsSupport.java @@ -35,7 +35,7 @@ /** * Support class to implement animation in tab headers to indicate some sort of - * 'busy' state.
          * The default implementation tracks changes in registered tab containers * (install(Tabbed, TabDataModel)) and if any tab is marked as 'busy' * (TopComponent.makeBusy(boolean)) it forces repeated repaints of diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/DefaultTabbedContainerUI.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/DefaultTabbedContainerUI.java index 3cfae3cc35c3..b49d6c011cf5 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/DefaultTabbedContainerUI.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/DefaultTabbedContainerUI.java @@ -468,10 +468,10 @@ protected LayoutManager createContentDisplayerLayout() { * Create the layout manager that will manage the layout of the * TabbedContainer. A TabbedContainer contains two components - the tabs * contentDisplayer, and the component contentDisplayer. - *

          + *

          * The layout manager determines the position of the tabs relative to the * contentDisplayer component which displays the tab contents. - *

          + *

          * The default implementation uses BorderLayout. If you override this, you * should probably override installDisplayer() as well. */ @@ -534,8 +534,8 @@ protected final Component toComp (TabData data) { * Shows the passed component. This method does not communicate with * the data model in any way shape or form, it just moves the passed * component to the front. It should only be called in response to an event - * from the data model or selection model. - *

          + * from the data model or selection model. + *

          * If you override createContentDisplayerLayoutModel() to * provide your own layout manager to arrange the displayed component, you * need to override this to tell the layout (or do whatever is needed) to @@ -624,7 +624,7 @@ protected void initDisplayer() { * cases such as removing the selected component appropriately, so if such a * model change happens, a selection change will be immediately forthcoming * to handle it. - *

          + *

          * Note that it is important that this listener be added to the data model * after the DefaultSelectionModel has added its listener. It is * important to create the displayer component before adding this listener. diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/EqualPolygon.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/EqualPolygon.java index 7921bd73a814..40790ead9eea 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/EqualPolygon.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/EqualPolygon.java @@ -34,12 +34,12 @@ * A Polygon which implements a proper equals/hashcode contract. In order to * optimize drag and drop repainting, it is necessary that the Shape objects * returned by getTabIndication() be able to be compared properly. - *

          + *

          * To ease migration of older code, this class also implements a couple methods * of GeneralPath, which was used before. These methods just delegate to * addPoint(), so the full functionality of GeneralPath is not replicated * (specifically, a polygon must be contiguous and closed). - *

          + *

          * * @author Tim Boudreau */ diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/MetalEditorTabCellRenderer.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/MetalEditorTabCellRenderer.java index d5eccc35888f..b5930e69bb73 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/MetalEditorTabCellRenderer.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/MetalEditorTabCellRenderer.java @@ -28,7 +28,7 @@ import java.awt.*; /** - * Renderer for editor tabs in metal l&f + * Renderer for editor tabs in metal l&f * * @author Tim Boudreau */ diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/TabCellRenderer.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/TabCellRenderer.java index ebcfccf7cce7..d06be8048f29 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/TabCellRenderer.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/TabCellRenderer.java @@ -100,7 +100,7 @@ public String getCommandAtPoint (Point p, int tabState, Rectangle bounds, int mo * Get the shape that represents those pixels actually occupied by the tab * on-screen. This is used for determining whether a mouse event really * occured on a tab, and for painting.

          A note on painting of tab drag - * and drop indication: AbstractTabsUI contains generic + * and drop indication: AbstractTabsUI contains generic * support for drawing drag and drop target indications. If want to use it * rather than write your own, you need to specify the polygon returned by * this method with the following point order: The last two points in the diff --git a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/TabState.java b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/TabState.java index 0aa98cff6a62..db7c0f9823b5 100644 --- a/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/TabState.java +++ b/platform/o.n.swing.tabcontrol/src/org/netbeans/swing/tabcontrol/plaf/TabState.java @@ -59,7 +59,8 @@ *

          * BasicTabDisplayerUI implements a mouse listener which will call the appropriate * methods when the mouse enters/exits tabs, etc. - *

          Details

          + *

          + * Details *

          * State is composed as an integer bitmask which covers all of the supported * states of a tab that may affect the way they paint. These are also the values that diff --git a/platform/openide.actions/src/org/openide/actions/SaveAction.java b/platform/openide.actions/src/org/openide/actions/SaveAction.java index f8c01a9bcb7b..b747f3097dba 100644 --- a/platform/openide.actions/src/org/openide/actions/SaveAction.java +++ b/platform/openide.actions/src/org/openide/actions/SaveAction.java @@ -43,7 +43,7 @@ /** Save a one or more objects. Since version 6.20 this handles ANY selection * instead of EXACTLY_ONE selection. - * @see savable + * @see Savable * @see SaveCookie * * @author Jan Jancura, Petr Hamernik, Ian Formanek, Dafe Simonek diff --git a/platform/openide.explorer/arch-propertysheet.xml b/platform/openide.explorer/arch-propertysheet.xml index ac5f6d38d2f0..1f06309e2604 100644 --- a/platform/openide.explorer/arch-propertysheet.xml +++ b/platform/openide.explorer/arch-propertysheet.xml @@ -600,7 +600,7 @@ DefaultPropertyModel to attempt to locate getter and setter methods on a random bean. Reflection is used during decision-making whether "Restore Default Value" Action should be disabled or enabled. This is due to the backward compatibility with properties in old modules (or new incorrectly implemented properties). See -#51907 for +#51907 for detailed description why we do so. diff --git a/platform/openide.explorer/src/org/openide/explorer/ExplorerManager.java b/platform/openide.explorer/src/org/openide/explorer/ExplorerManager.java index 5a170a5d9c32..2d024b9d2a55 100644 --- a/platform/openide.explorer/src/org/openide/explorer/ExplorerManager.java +++ b/platform/openide.explorer/src/org/openide/explorer/ExplorerManager.java @@ -352,7 +352,7 @@ public void fire() { * @param value the new node to explore, or null if none should be explored. * @param selection the new nodes to be selected * @throws IllegalArgumentException if the node is not within the current root context in the node hierarchy - * @throws PropertyVetoExcepion if listeners attached to this explorer manager do so + * @throws PropertyVetoException if listeners attached to this explorer manager do so */ public final void setExploredContextAndSelection(final Node value, final Node[] selection) throws PropertyVetoException { @@ -794,7 +794,7 @@ public void run() { * that implements {@link Provider}.

          This method should be used in * {@link Component#addNotify} of each component that works with the * Explorer manager, e.g.: - * 

          +     * 
                * private transient ExplorerManager explorer;
      *
      * public void addNotify () {
diff --git a/platform/openide.explorer/src/org/openide/explorer/ExplorerUtils.java b/platform/openide.explorer/src/org/openide/explorer/ExplorerUtils.java
index bbdd363802dd..6dab2eac59b4 100644
--- a/platform/openide.explorer/src/org/openide/explorer/ExplorerUtils.java
+++ b/platform/openide.explorer/src/org/openide/explorer/ExplorerUtils.java
@@ -46,7 +46,7 @@
  *
         // following line tells the top component which lookup should be associated with it
         associateLookup (ExplorerUtils.createLookup (manager, map));
-    }
+    }
     public ExplorerManager getExplorerManager() {
         return manager;
     }
@@ -68,7 +68,7 @@
 implements ExplorerManager.Provider, Lookup.Provider {
     private ExplorerManager manager;
     private Lookup lookup;
-    public YourComponent() {
+    public YourComponent() {
         // same as before...
         manager = new ExplorerManager();
         ActionMap map = getActionMap();
diff --git a/platform/openide.explorer/src/org/openide/explorer/propertysheet/ButtonPanel.java b/platform/openide.explorer/src/org/openide/explorer/propertysheet/ButtonPanel.java
index a503e22b0f3d..a0b3af7694e1 100644
--- a/platform/openide.explorer/src/org/openide/explorer/propertysheet/ButtonPanel.java
+++ b/platform/openide.explorer/src/org/openide/explorer/propertysheet/ButtonPanel.java
@@ -457,7 +457,7 @@ public Dimension getMinimumSize() {
      * custom editor button.
      * 
          
      * This class also contains the ability to create an image buffer of itself
-     * and use it for its lifetime.  On XP and Aqua L&Fs, button painting is
+     * and use it for its lifetime.  On XP and Aqua L&Fs, button painting is
      * expensive, and a huge amount of a treetable or property sheet's painting
      * cycle gets spent scaling the backing bitmap for a button that will
      * always be painted exactly the same size.
diff --git a/platform/openide.explorer/src/org/openide/explorer/propertysheet/DefaultPropertyModel.java b/platform/openide.explorer/src/org/openide/explorer/propertysheet/DefaultPropertyModel.java
index f261cac05585..bd85e44e12b3 100644
--- a/platform/openide.explorer/src/org/openide/explorer/propertysheet/DefaultPropertyModel.java
+++ b/platform/openide.explorer/src/org/openide/explorer/propertysheet/DefaultPropertyModel.java
@@ -88,7 +88,7 @@ public DefaultPropertyModel(Object bean, String propertyName)
      * panel = new PropertyPanel (model);
      * 
          
      * This constructor replaces the default use of BeanInfo and that is why
-     * simplifies the use of ExPropertyEditors.
+     * simplifies the use of {@link ExPropertyEditor}s.
      *
      * @param bean the java bean to be introspected
      * @param descr the property descriptor of the property to use
diff --git a/platform/openide.explorer/src/org/openide/explorer/propertysheet/PropertyPanel.java b/platform/openide.explorer/src/org/openide/explorer/propertysheet/PropertyPanel.java
index 1cc13329bbca..80e47ead5d11 100644
--- a/platform/openide.explorer/src/org/openide/explorer/propertysheet/PropertyPanel.java
+++ b/platform/openide.explorer/src/org/openide/explorer/propertysheet/PropertyPanel.java
@@ -806,8 +806,8 @@ public void setPreferences(int preferences) {
      * In such a case, the PropertyModel instance thus obtained will not
      * fire changes due to changes made by calling setValue
      * on the Node.Property.  For details on why this is the case,
-     * see issue
-     * 37779          .
+     * see issue
+     * 37779.
      *
      * @return Either the PropertyModel set in the constructor or via setModel,
      * or a generated instance of PropertyModel which wraps the Node.Property
@@ -948,8 +948,8 @@ public final Node.Property getProperty() {
     }
 
     /** Getter for the state of the property editor. The editor can be in
-     * not valid states just if it implements the ExPropertyEditor
-     * and changes state by the setState method of the PropertyEnv
+     * not valid states just if it implements the {@link ExPropertyEditor}
+     * and changes state by the setState method of the {@link PropertyEnv}
      * environment.
      * 
          
      * @return PropertyEnv.STATE_VALID if the editor is not the ExPropertyEditor
@@ -975,7 +975,7 @@ public final Object getState() {
         return PropertyEnv.STATE_VALID;
     }
 
-    /** If the editor is ExPropertyEditor it tries to change the
+    /** If the editor is {@link ExPropertyEditor} it tries to change the
      * getState property to PropertyEnv.STATE_VALID
      * state. This may be vetoed, in such case a warning is presented to the user
      * and the getState will still return the original value
diff --git a/platform/openide.explorer/src/org/openide/explorer/propertysheet/PropertySheetView.java b/platform/openide.explorer/src/org/openide/explorer/propertysheet/PropertySheetView.java
index 57eb896997e0..c59449943e98 100644
--- a/platform/openide.explorer/src/org/openide/explorer/propertysheet/PropertySheetView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/propertysheet/PropertySheetView.java
@@ -33,7 +33,7 @@
  * properties for currently selected {@link Node}
  *
  * 
          
- * This class is a view
+ * This class is a view
  * to use it properly you need to add it into a component which implements
  * {@link Provider}. Good examples of that can be found
  * in {@link ExplorerUtils}. Then just use 
@@ -41,7 +41,7 @@
  * and control its state.
  * 
          
  * 
          
- * There can be multiple views under one container implementing {@link Provider}. Select from
+ * There can be multiple views under one container implementing {@link Provider}. Select from
  * range of predefined ones or write your own:
  * 
          
  * 
            
diff --git a/platform/openide.explorer/src/org/openide/explorer/propertysheet/editors/XMLPropertyEditor.java b/platform/openide.explorer/src/org/openide/explorer/propertysheet/editors/XMLPropertyEditor.java
index b7dffe67647c..e011798e74bf 100644
--- a/platform/openide.explorer/src/org/openide/explorer/propertysheet/editors/XMLPropertyEditor.java
+++ b/platform/openide.explorer/src/org/openide/explorer/propertysheet/editors/XMLPropertyEditor.java
@@ -31,7 +31,7 @@ public interface XMLPropertyEditor extends java.beans.PropertyEditor {
     * the value should be available via the getValue method.
     * An IOException should be thrown when the value cannot be restored from the specified XML element
     * @param element the XML DOM element representing a subtree of XML from which the value should be loaded
-    * @exception IOException thrown when the value cannot be restored from the specified XML element
+    * @exception java.io.IOException thrown when the value cannot be restored from the specified XML element
     */
     public void readFromXML(org.w3c.dom.Node element) throws java.io.IOException;
 
diff --git a/platform/openide.explorer/src/org/openide/explorer/view/BeanTreeView.java b/platform/openide.explorer/src/org/openide/explorer/view/BeanTreeView.java
index ba608be671ca..e8dc41305323 100644
--- a/platform/openide.explorer/src/org/openide/explorer/view/BeanTreeView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/view/BeanTreeView.java
@@ -34,7 +34,7 @@
 /** Displays {@link Node} hierarchy as a tree of all nodes.
  *
  * 
            
- * This class is a view
+ * This class is a view
  * to use it properly you need to add it into a component which implements
  * {@link Provider}. Good examples of that can be found 
  * in {@link ExplorerUtils}. Then just use 
@@ -42,7 +42,7 @@
  * and control its state.
  * 
            
  * 
            
- * There can be multiple views under one container implementing {@link Provider}. Select from
+ * There can be multiple views under one container implementing {@link Provider}. Select from
  * range of predefined ones or write your own:
  * 
            
  * 
              
diff --git a/platform/openide.explorer/src/org/openide/explorer/view/ChoiceView.java b/platform/openide.explorer/src/org/openide/explorer/view/ChoiceView.java
index e7deac4cc57a..92c6f952ba29 100644
--- a/platform/openide.explorer/src/org/openide/explorer/view/ChoiceView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/view/ChoiceView.java
@@ -32,7 +32,7 @@
 
 /** Explorer view based on a combo box.
  * 
              
- * This class is a view
+ * This class is a view
  * to use it properly you need to add it into a component which implements
  * {@link Provider}. Good examples of that can be found
  * in {@link ExplorerUtils}. Then just use
@@ -40,7 +40,7 @@
  * and control its state.
  * 
              
  * 
              
- * There can be multiple views under one container implementing {@link Provider}. Select from
+ * There can be multiple views under one container implementing {@link Provider}. Select from
  * range of predefined ones or write your own:
  * 
              
  * 
                
diff --git a/platform/openide.explorer/src/org/openide/explorer/view/ContextTreeView.java b/platform/openide.explorer/src/org/openide/explorer/view/ContextTreeView.java
index 7ed3b99afde0..d669df1e179b 100644
--- a/platform/openide.explorer/src/org/openide/explorer/view/ContextTreeView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/view/ContextTreeView.java
@@ -36,7 +36,7 @@
  * Works well together (e.g. sharing one {@link ExplorerManager}) with {@link ListView}.
  *
  * 
                
- * This class is a view
+ * This class is a view
  * to use it properly you need to add it into a component which implements
  * {@link Provider}. Good examples of that can be found 
  * in {@link ExplorerUtils}. Then just use 
@@ -44,7 +44,7 @@
  * and control its state.
  * 
                
  * 
                
- * There can be multiple views under one container implementing {@link Provider}. Select from
+ * There can be multiple views under one container implementing {@link Provider}. Select from
  * range of predefined ones or write your own:
  * 
                
  * 
                  
diff --git a/platform/openide.explorer/src/org/openide/explorer/view/IconView.java b/platform/openide.explorer/src/org/openide/explorer/view/IconView.java
index 38ee7fef6b36..47598f9d0125 100644
--- a/platform/openide.explorer/src/org/openide/explorer/view/IconView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/view/IconView.java
@@ -32,15 +32,15 @@
 
 /** A view displaying {@link Node}s as icons.
  * 
                  
- * This class is a view
+ * This class is a view
  * to use it properly you need to add it into a component which implements
- * {@link Provider}. Good examples of that can be found 
+ * {@link org.openide.explorer.ExplorerManager.Provider}. Good examples of that can be found 
  * in {@link ExplorerUtils}. Then just use 
- * {@link Provider#getExplorerManager} call to get the {@link ExplorerManager}
+ * {@link org.openide.explorer.ExplorerManager.Provider#getExplorerManager} call to get the {@link ExplorerManager}
  * and control its state.
  * 
                  
  * 
                  
- * There can be multiple views under one container implementing {@link Provider}. Select from
+ * There can be multiple views under one container implementing {@link org.openide.explorer.ExplorerManager.Provider}. Select from
  * range of predefined ones or write your own:
  * 
                  
  * 
                    
@@ -49,7 +49,7 @@
  *      
                  • {@link org.openide.explorer.view.ListView} - shows a list of nodes
                    • 
  *      
                  • {@link org.openide.explorer.view.IconView} - shows a rows of nodes with bigger icons
                    • 
  *      
                  • {@link org.openide.explorer.view.ChoiceView} - creates a combo box based on the explored nodes
                    • 
- *      
                  • {@link org.openide.explorer.view.TreeTableView} - shows tree of nodes together with a set of their {@link Property}
                    • 
+ *      
                  • {@link org.openide.explorer.view.TreeTableView} - shows tree of nodes together with a set of their {@link org.openide.nodes.Node.Property}
                    • 
  *      
                  • {@link org.openide.explorer.view.MenuView} - can create a {@link JMenu} structure based on structure of {@link Node}s
                    • 
  * 
                  
  * 
                  
diff --git a/platform/openide.explorer/src/org/openide/explorer/view/ListView.java b/platform/openide.explorer/src/org/openide/explorer/view/ListView.java
index 7680720f1e21..f3a736590fcf 100644
--- a/platform/openide.explorer/src/org/openide/explorer/view/ListView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/view/ListView.java
@@ -80,7 +80,7 @@
 
 /** Explorer view to display items in a list.
  * 
                  
- * This class is a view
+ * This class is a view
  * to use it properly you need to add it into a component which implements
  * {@link Provider}. Good examples of that can be found 
  * in {@link org.openide.explorer.ExplorerUtils}. Then just use 
@@ -88,7 +88,7 @@
  * and control its state.
  * 
                  
  * 
                  
- * There can be multiple views under one container implementing {@link Provider}. Select from
+ * There can be multiple views under one container implementing {@link Provider}. Select from
  * range of predefined ones or write your own:
  * 
                  
  * 
                    
diff --git a/platform/openide.explorer/src/org/openide/explorer/view/MenuView.java b/platform/openide.explorer/src/org/openide/explorer/view/MenuView.java
index 116539766501..6be05f39441f 100644
--- a/platform/openide.explorer/src/org/openide/explorer/view/MenuView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/view/MenuView.java
@@ -48,7 +48,7 @@
 * explored context.
  *
  * 
                    
- * This class is a view
+ * This class is a view
  * to use it properly you need to add it into a component which implements
  * {@link Provider}. Good examples of that can be found 
  * in {@link ExplorerUtils}. Then just use 
@@ -56,7 +56,7 @@
  * and control its state.
  * 
                    
  * 
                    
- * There can be multiple views under one container implementing {@link Provider}. Select from
+ * There can be multiple views under one container implementing {@link Provider}. Select from
  * range of predefined ones or write your own:
  * 
                    
  * 
                      
@@ -306,13 +306,13 @@ public Menu(Node node, NodeAcceptor action) {
             this(node, action, true);
         }
 
-        /** @deprecated use {@link MenuView.Menu#MenuView.Menu(Node, NodeAcceptor)}
+        /** @deprecated use {@link #Menu(Node, NodeAcceptor)}
          */
         public @Deprecated Menu(Node node, Acceptor action) {
             this(node, new AcceptorProxy(action), true);
         }
 
-        /** @deprecated use {@link MenuView.Menu#MenuView.Menu(Node, NodeAcceptor, boolean)}
+        /** @deprecated use {@link #Menu(Node, NodeAcceptor, boolean)}
          */
         public @Deprecated Menu(Node node, Acceptor action, boolean setName) {
             this(node, new AcceptorProxy(action), setName);
diff --git a/platform/openide.explorer/src/org/openide/explorer/view/OutlineView.java b/platform/openide.explorer/src/org/openide/explorer/view/OutlineView.java
index d4f55eb1a975..707207c9b8ec 100644
--- a/platform/openide.explorer/src/org/openide/explorer/view/OutlineView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/view/OutlineView.java
@@ -423,13 +423,14 @@ public int getTreeHorizontalScrollBarPolicy() {
      * @see #getTreeHorizontalScrollBarPolicy
      * @since 6.30
      *
-     * @beaninfo
+     * 
                       beaninfo taglet
      *   preferred: true
      *       bound: true
      * description: The tree column scrollbar policy
      *        enum: HORIZONTAL_SCROLLBAR_AS_NEEDED ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
      *              HORIZONTAL_SCROLLBAR_NEVER ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER
      *              HORIZONTAL_SCROLLBAR_ALWAYS ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS
+     * 
                      
      */
     public void setTreeHorizontalScrollBarPolicy(int policy) {
         if (policy == treeHorizontalScrollBarPolicy) {
@@ -691,7 +692,7 @@ public void setPopupAllowed (boolean value) {
      * Enable/disable double click to invoke default action.
      * If the default action is not enabled, double click expand/collapse node.
      * @param defaultActionAllowed Provide true to enable
-     * @see {@link #isDefaultActionAllowed()}
+     * @see #isDefaultActionAllowed()
      * @since 6.32
      */
     public void setDefaultActionAllowed(boolean defaultActionAllowed) {
@@ -701,7 +702,7 @@ public void setDefaultActionAllowed(boolean defaultActionAllowed) {
     /**
      * Tells if double click invokes default action.
      * @return true if the default action is invoked, or false when it's not.
-     * @see {@link #setDefaultActionAllowed(boolean)}
+     * @see #setDefaultActionAllowed(boolean)
      * @since 6.32
      */
     public boolean isDefaultActionAllowed() {
diff --git a/platform/openide.explorer/src/org/openide/explorer/view/TreeTableView.java b/platform/openide.explorer/src/org/openide/explorer/view/TreeTableView.java
index 2c469df62742..ad5c9697450e 100644
--- a/platform/openide.explorer/src/org/openide/explorer/view/TreeTableView.java
+++ b/platform/openide.explorer/src/org/openide/explorer/view/TreeTableView.java
@@ -67,7 +67,7 @@
  * and its properties in table on the right.
  * 
                      
  * The main mechanism for setting what properties are displayed is
- * setProperties (Node.Property[]).
+ * {@link #setProperties(org.openide.nodes.Node.Property[])}.
  * Pass this method an
  * array of properties.  These will act as a template, and properties of
  * the displayed nodes which share the same name will be used in
@@ -83,7 +83,8 @@
  * should set its custom parameter:
  * 
                      properties[1].setValue ("InvisibleInTreeTableView", Boolean.TRUE);
  *
- * 
+ * 
                      
+ * 
  *     
  *         
@@ -151,7 +152,7 @@
  * 
                      custom parameter list
                       Parameter name
  *         
                      
  *
  * 
                      
- * This class is a view
+ * This class is a view
  * to use it properly you need to add it into a component which implements
  * {@link Provider}. Good examples of that can be found 
  * in {@link ExplorerUtils}. Then just use 
@@ -159,7 +160,7 @@
  * and control its state.
  * 
                      
  * 
                      
- * There can be multiple views under one container implementing {@link Provider}. Select from
+ * There can be multiple views under one container implementing {@link Provider}. Select from
  * range of predefined ones or write your own:
  * 
                      
  * 
                        
diff --git a/platform/openide.loaders/arch.xml b/platform/openide.loaders/arch.xml
index 71bf524d170b..752ad8b324dc 100644
--- a/platform/openide.loaders/arch.xml
+++ b/platform/openide.loaders/arch.xml
@@ -56,7 +56,7 @@
     A lot of usecases is described in the javadoc. Here 
     is the list of some faqs:
   
-    
+    
         
                        
         Often many people require ability to create a "clever" template - e.g.
         write piece of simple text and at the time of its 
@@ -64,7 +64,7 @@
             processing
         
         do some advanced changes to it using either 
-        scripting or templating languages.
+        scripting or templating languages.
         
                        
         
         
                        
@@ -497,7 +497,7 @@ for more information about this.
 
      
         This is a standard way to find a class of a SAX2 driver. See
-         SAX2 documentation 
+         SAX2 documentation 
     
 
      
@@ -539,7 +539,7 @@ for more information about this.
         DataObject.createFromTemplate,
         it passes as argument all its properties
         to it with prefix wizard.. That way they are available to
-        underlaying scripting and templating
+        underlaying scripting and templating
         engines.
     
 
diff --git a/platform/openide.loaders/src/org/openide/loaders/CreateFromTemplateAttributesProvider.java b/platform/openide.loaders/src/org/openide/loaders/CreateFromTemplateAttributesProvider.java
index e19cb996f31a..610f03d9c78a 100644
--- a/platform/openide.loaders/src/org/openide/loaders/CreateFromTemplateAttributesProvider.java
+++ b/platform/openide.loaders/src/org/openide/loaders/CreateFromTemplateAttributesProvider.java
@@ -21,12 +21,12 @@
 
 import java.util.Map;
 
-/** This is an interface for smart templating.
+/** This is an interface for smart templating.
  * Implementations of this class can be registered in the global {@link org.openide.util.Lookup}
  * and allows anyone provide additional parameters to each {@link CreateFromTemplateHandler}s
  * when a template is instantiating.
- * Read more in the howto document.
- * 
                        
+ * Read more in the howto document.
+ * 
                        
  * Since templating system need not to depend on Data Systems APIs, the relevant interfaces
  * were moved to the {@code openide.filesystems.templates} module. This interface has been kept
  * for backward compatibility and DataSystems provide a compatibility bridge, which allows
@@ -37,7 +37,7 @@
  * @author Jaroslav Tulach
  * @since 6.3
  * @since deprecated from 7.59
- * @deprecated Use {@link CreateFromTemplateAttributes} in {@code openide.filesystems.templates} instead.
+ * @deprecated Use {@link org.netbeans.api.templates.CreateFromTemplateAttributes} instead.
  */
 @Deprecated
 public interface CreateFromTemplateAttributesProvider {
diff --git a/platform/openide.loaders/src/org/openide/loaders/CreateFromTemplateHandler.java b/platform/openide.loaders/src/org/openide/loaders/CreateFromTemplateHandler.java
index 03e4794b93ac..52f52e6264d5 100644
--- a/platform/openide.loaders/src/org/openide/loaders/CreateFromTemplateHandler.java
+++ b/platform/openide.loaders/src/org/openide/loaders/CreateFromTemplateHandler.java
@@ -26,12 +26,12 @@
 import org.netbeans.api.templates.CreateDescriptor;
 import org.openide.filesystems.FileObject;
 
-/** This is an interface for smart templating that allows
+/** This is an interface for smart templating that allows
  * any module to intercept calls to {@link DataObject#createFromTemplate} 
  * and handle them themselves. The NetBeans IDE provides default
  * implementation that allows use of Freemarker templating engine.
- * Read more in the howto document.
- * 
                        
+ * Read more in the howto document.
+ * 
                        
  * This SPI is now deprecated and serves just a backward compatilibity SPI adapter
  * which allows the template API to work with legacy handlers. The templating SPI is delegated
  * to the original handler methods.
@@ -91,7 +91,7 @@ protected abstract FileObject createFromTemplate(
      * parameter set to {@link Boolean#TRUE}
      * (such as from {@link DataObject#createFromTemplate(DataFolder,String,Map)}),
      * and the file name already seems to
-     * include an extension (*.*), the handler should not append
+     * include an extension (*.*), the handler should not append
      * any extension from the template.
      * @since org.openide.loaders 7.16
      * @see Templates.SimpleTargetChooserBuilder.freeFileExtension
diff --git a/platform/openide.loaders/src/org/openide/loaders/DataLoader.java b/platform/openide.loaders/src/org/openide/loaders/DataLoader.java
index b4ea3b6930be..6145569bd835 100644
--- a/platform/openide.loaders/src/org/openide/loaders/DataLoader.java
+++ b/platform/openide.loaders/src/org/openide/loaders/DataLoader.java
@@ -204,7 +204,7 @@ final Action[] getSwingActions () {
      * 
                        
      * {@link javax.swing.JSeparator} instances may be used to separate items.
      * 
                        
-     * Suggested context name: Loaders/PRIMARY-FILE/MIME-TYPE/Actions
+     * Suggested context name: Loaders/PRIMARY-FILE/MIME-TYPE/Actions
      *
      * @return the string name of the context on layer files to read/write actions to
      * @since 5.0
diff --git a/platform/openide.loaders/src/org/openide/loaders/DataLoaderPool.java b/platform/openide.loaders/src/org/openide/loaders/DataLoaderPool.java
index beade10cf584..cc673a89fda0 100644
--- a/platform/openide.loaders/src/org/openide/loaders/DataLoaderPool.java
+++ b/platform/openide.loaders/src/org/openide/loaders/DataLoaderPool.java
@@ -620,7 +620,7 @@ public static DataLoader getPreferredLoader (FileObject fo) {
      *   <attr name="iconBase" stringvalue="org/your/pkg/YourDataObject.png"/>
      * </file>
      *
          - * @param clazz the class of the data object to create. Must have appropriate + * @param dataObjectClass the class of the data object to create. Must have appropriate * constructor. * @param mimeType the mime type associated with the object, used for * example to create the right actions for the object's node diff --git a/platform/openide.loaders/src/org/openide/loaders/DataNode.java b/platform/openide.loaders/src/org/openide/loaders/DataNode.java index 9dacc089d68b..0ee54c3697c8 100644 --- a/platform/openide.loaders/src/org/openide/loaders/DataNode.java +++ b/platform/openide.loaders/src/org/openide/loaders/DataNode.java @@ -209,7 +209,6 @@ private java.awt.Image getImageFromFactory(int type) { } /** Get the displayed icon for this node. - * A filesystem may {@link org.openide.filesystems.FileSystem#getStatus specially alter} this. * Subclassers overriding this method should consider the recommendations * in {@link DataObject#createNodeDelegate}. * @param type the icon type from {@link java.beans.BeanInfo} @@ -232,7 +231,6 @@ public java.awt.Image getIcon (int type) { } /** Get the displayed icon for this node. - * A filesystem may {@link org.openide.filesystems.FileSystem#getStatus specially alter} this. * Subclassers overriding this method should consider the recommendations * in {@link DataObject#createNodeDelegate}. * @param type the icon type from {@link java.beans.BeanInfo} diff --git a/platform/openide.loaders/src/org/openide/loaders/DataObject.java b/platform/openide.loaders/src/org/openide/loaders/DataObject.java index 98dd6396bfd8..369d0ca40452 100644 --- a/platform/openide.loaders/src/org/openide/loaders/DataObject.java +++ b/platform/openide.loaders/src/org/openide/loaders/DataObject.java @@ -115,12 +115,12 @@ public abstract class DataObject extends Object private static final Set syncModified = Collections.synchronizedSet(modified); /** Modified flag - * @GuardedBy(LOCK) + * @GuardedBy(LOCK) */ private boolean modif = false; /** the node delegate for this data object - * @GuardedBy(LOCK) + * @GuardedBy(LOCK) */ private transient Node nodeDelegate; private static final Node BEING_CREATED = Node.EMPTY.cloneNode(); @@ -139,7 +139,7 @@ public abstract class DataObject extends Object private volatile PropertyChangeSupport changeSupport; /** vetoable property change listener support - * @GuardedBy(LOCK) + * @GuardedBy(LOCK) */ private VetoableChangeSupport vetoableChangeSupport; @@ -394,12 +394,11 @@ final void setNodeDelegate(Node n) { *

          * This method is called only once per data object. *

          It is strongly recommended that the resulting node will, when asked for - * the cookie DataObject.class, return this same data object. + * the cookie DataObject.class, return this same data object. *

          It is also recommended that the node: *

            *
          1. Base its name on {@link #getName}. *
          2. Base its display name additionally on {@link DataNode#getShowFileExtensions}. - *
          3. Tune its display name and icon according to {@link org.openide.filesystems.FileSystem.Status}. *
          * @return the node delegate (without parent) for this data object * @see Datasystems API - Creating a node delegate @@ -1255,7 +1254,7 @@ static String getString (String name) { /** Factory interface for converting file object to data objects. Read * more about the layer based registrations in - * separate document. + * separate document. * @since 7.0 */ public static interface Factory { @@ -1269,7 +1268,7 @@ public static interface Factory { * primary file already exists * @exception IOException if the object is recognized but cannot be created * @exception InvalidClassException if the class is not instance of - * {@link #getRepresentationClass} + * {@link DataLoader#getRepresentationClass} * * @return suitable data object or null if the handler cannot * recognize this object (or its group) @@ -1316,7 +1315,7 @@ public static interface Container extends Node.Cookie { public static @interface Registration { /** * Mime type to recognize. Use - * {@link MIMEResolver.ExtensionRegistration} and co. to assign + * {@link org.openide.filesystems.MIMEResolver.ExtensionRegistration} and co. to assign * a mime types to {@link FileObject files} in the system. */ String mimeType(); diff --git a/platform/openide.loaders/src/org/openide/loaders/FileEntry.java b/platform/openide.loaders/src/org/openide/loaders/FileEntry.java index 3ac38c68dc8a..ae8dad885ffd 100644 --- a/platform/openide.loaders/src/org/openide/loaders/FileEntry.java +++ b/platform/openide.loaders/src/org/openide/loaders/FileEntry.java @@ -360,7 +360,7 @@ public FileObject rename (String name) throws IOException { /** Deletes folder associated with entry. Although filesystems delete * folders recursively, it is better to delete children DataObjects before - * the {@link #FileEntry.Folder} entry is deleted. + * the {@link FileEntry.Folder} entry is deleted. * @exception IOException when the operation fails */ public void delete () throws IOException { diff --git a/platform/openide.loaders/src/org/openide/loaders/FolderLookup.java b/platform/openide.loaders/src/org/openide/loaders/FolderLookup.java index 0cf296ed0f20..9692d292285b 100644 --- a/platform/openide.loaders/src/org/openide/loaders/FolderLookup.java +++ b/platform/openide.loaders/src/org/openide/loaders/FolderLookup.java @@ -174,7 +174,7 @@ protected final Object createInstance(InstanceCookie[] cookies) } /** Overrides superclass method. It returns instance - * for DataObject&InstanceCookie 'pair'. + * for DataObject&InstanceCookie 'pair'. * If the instance is of FolderLookup.Lkp class it is created otherwise * new Lkp.ICItem created and returned. * diff --git a/platform/openide.loaders/src/org/openide/loaders/SaveAsCapable.java b/platform/openide.loaders/src/org/openide/loaders/SaveAsCapable.java index 29b14340652b..f77f5f4922c2 100644 --- a/platform/openide.loaders/src/org/openide/loaders/SaveAsCapable.java +++ b/platform/openide.loaders/src/org/openide/loaders/SaveAsCapable.java @@ -29,17 +29,17 @@ * editor support inherits from DataEditorSupport you can implement "Save As" feature * for your documents by adding the following lines into your {@link DataObject}'s constructor: * -
          +
          {@code
         getCookieSet().assign(SaveAsCapable.class, new SaveAsCapable() {
             public void saveAs(FileObject folder, String fileName) throws IOException {
                 getDataEditorSupport().saveAs( folder, fileName );
             }
         });
-
          
+}
          * - * If you have {@link Node}, you may use the following code: + * If you have {@link org.openide.nodes.Node}, you may use the following code: * -
          +
          {@code
     public class MyNode extends AbstractNode {
         
         public MyNode() {
@@ -75,7 +75,7 @@ public void saveAs(FileObject folder, String fileName) throws IOException {
             }
         }
     }
-
          
+}
          * * @since 6.3 * @author S. Aubrecht diff --git a/platform/openide.loaders/src/org/openide/loaders/XMLDataObject.java b/platform/openide.loaders/src/org/openide/loaders/XMLDataObject.java index c22af3621ec9..51845241ddc3 100644 --- a/platform/openide.loaders/src/org/openide/loaders/XMLDataObject.java +++ b/platform/openide.loaders/src/org/openide/loaders/XMLDataObject.java @@ -148,7 +148,7 @@ public class XMLDataObject extends MultiDataObject { /** * Create new XMLDataObject. It is usually called by a loader. * A user can get existing XMLDataObject by calling {@link DataObject#find(FileObject) - * DataObject.find(FileObject f)} instead. + * DataObject.find(FileObject f)} instead. * * @param fo the primary file object, never null * @param loader loader of this data object, never null @@ -654,13 +654,13 @@ public static Parser createParser (boolean validate) { * It directly violates DOM's root element reference read-only status. * If you can not move to XMLUtil for compatabilty reasons please * replace with following workaround: - * 
          +     * 
          {@code
      * String templ = "";
      * InputSource in = new InputSource(new StringReader(templ));
      * in.setSystemId("StringReader");  //workaround
      * DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
      * Document doc = builder.parse(in);
-     * 
          
+     * }
          */ @Deprecated public static Document createDocument() { diff --git a/platform/openide.loaders/src/org/openide/text/DataEditorSupport.java b/platform/openide.loaders/src/org/openide/text/DataEditorSupport.java index a05c8c757bc0..16f357e5c10d 100644 --- a/platform/openide.loaders/src/org/openide/text/DataEditorSupport.java +++ b/platform/openide.loaders/src/org/openide/text/DataEditorSupport.java @@ -157,7 +157,7 @@ public static CloneableEditorSupport create (DataObject obj, MultiDataObject.Ent /** Factory method to create a bit more complicated CloneableEditorSupport for a given * entry of a given DataObject. The common use inside DataObject looks like * this: - * 
          +     * 
          {@code
      *  getCookieSet().add((Node.Cookie) DataEditorSupport.create(
      *    this, getPrimaryEntry(), getCookieSet(),
      *    new Callable() { 
@@ -166,7 +166,7 @@ public static CloneableEditorSupport create (DataObject obj, MultiDataObject.Ent
      *      }
      *    }
      *  ));
-     * 
          
+     * }
          * The method can be used to instantiate multi view editor by returning * * MultiViews.createCloneableMultiView("text/yourmime", this). @@ -435,7 +435,7 @@ protected boolean canClose() { } /** - * @inheritDoc + * {@inheritDoc} */ @Override protected void loadFromStreamToKit(StyledDocument doc, InputStream stream, EditorKit kit) throws IOException, BadLocationException { @@ -512,7 +512,7 @@ private static synchronized int decrementCacheCounter(DataObject tmpObj) { } /** - * @inheritDoc + * {@inheritDoc} */ @Override protected void saveFromKitToStream(StyledDocument doc, EditorKit kit, OutputStream stream) throws IOException, BadLocationException { diff --git a/platform/openide.options/src/org/openide/explorer/propertysheet/PropertySheetSettings.java b/platform/openide.options/src/org/openide/explorer/propertysheet/PropertySheetSettings.java index 8ae855fb21c7..fa4fa81de71f 100644 --- a/platform/openide.options/src/org/openide/explorer/propertysheet/PropertySheetSettings.java +++ b/platform/openide.options/src/org/openide/explorer/propertysheet/PropertySheetSettings.java @@ -29,7 +29,7 @@ /** * Settings for the property sheet. -* @see PropertySheet +* @see PropertySheet * * @deprecated None of the settings in this class are supported in the new property sheet. The entire implementation * has been gutted to do nothing. diff --git a/platform/openide.options/src/org/openide/options/ContextSystemOption.java b/platform/openide.options/src/org/openide/options/ContextSystemOption.java index b7aa9ddd34cb..27d299fac16d 100644 --- a/platform/openide.options/src/org/openide/options/ContextSystemOption.java +++ b/platform/openide.options/src/org/openide/options/ContextSystemOption.java @@ -190,7 +190,7 @@ public int compare(Object o1, Object o2) { /** A hierarchy of SystemOptions. * Allows add/remove SystemOption beans only. - * @warning many methods throws UnsupportedOperationException like BeanContextSupport does. + * warning many methods throws UnsupportedOperationException like BeanContextSupport does. */ private static class OptionBeanContext extends BeanContextSupport implements PropertyChangeListener { private static final long serialVersionUID = 3532434266136225440L; diff --git a/platform/openide.text/src/org/openide/text/Line.java b/platform/openide.text/src/org/openide/text/Line.java index 673ac48bc238..fd060b8a1d02 100644 --- a/platform/openide.text/src/org/openide/text/Line.java +++ b/platform/openide.text/src/org/openide/text/Line.java @@ -218,12 +218,12 @@ public final org.openide.util.Lookup getLookup() { /** Get the line number. The last condition in following should * always be true: - * 
          +    * 
          {@code 
     *   Line.Set lineSet = 
     *   Line l = 
     *
     *   l.equals (lineSet.getCurrent (l.getLineNumber ()))
-    * 
          
+    * }
          * * @return current line number (may change as text is edited) (starting at 0) */ diff --git a/platform/openide.text/src/org/openide/text/NbDocument.java b/platform/openide.text/src/org/openide/text/NbDocument.java index f8c6f5d5fdf2..7f20fd81b2e6 100644 --- a/platform/openide.text/src/org/openide/text/NbDocument.java +++ b/platform/openide.text/src/org/openide/text/NbDocument.java @@ -176,13 +176,13 @@ public static int findLineOffset(StyledDocument doc, int lineNumber) { return new DocumentRenderer(DocumentRenderer.FIND_LINE_OFFSET, doc, lineNumber).renderToInt(); } - /** Creates position with a bias. If the bias is {@link javax.swing.text.Position.Bias#Backward} + /** Creates position with a bias. If the bias is {@link javax.swing.text.Position.Bias#Backward Backward} * then if an insert occures at the position, the text is inserted - * after the position. If the bias is {@link javax.swing.text.Position.Bias#Forward Forward}, then the text is + * after the position. If the bias is {@link javax.swing.text.Position.Bias#Forward Forward}, then the text is * inserted before the position. *

          * The method checks if the document implements {@link PositionBiasable}, - * and if so, {@link PositionBiasable#createPosition createPosition} is called. + * and if so, {@link PositionBiasable#createPosition createPosition} is called. * Otherwise an attempt is made to provide a Position with the correct behavior. * * @param doc document to create position in @@ -396,7 +396,7 @@ public static JEditorPane findRecentEditorPane (EditorCookie ec) { } /** Locks the document to have exclusive access to it. - * Documents implementing {@link Lockable} can specify exactly how to do this. + * Documents implementing {@link WriteLockable} can specify exactly how to do this. * * @param doc document to lock * @param run the action to run @@ -474,7 +474,7 @@ public static Object findPageable(StyledDocument doc) { /** * Add annotation to the document. For annotation of whole line * the length parameter can be ignored (specify value -1). - *
          + *
          * Note: since 6.35 the requests (delegated to document) are no longer replanned to EDT. * @param doc the document which will be annotated * @param startPos position which represent begining @@ -495,7 +495,7 @@ public static void addAnnotation( /** * Removal of added annotation. - *
          + *
          * Note: since 6.35 the requests (delegated to document) are no longer replanned to EDT. * @param doc the annotated document * @param annotation annotation which is going to be removed @@ -789,9 +789,9 @@ public interface Printable extends Document { * If not, special support for the position is created. */ public interface PositionBiasable extends Document { - /** Creates position with a bias. If the bias is {@link javax.swing.text.Position.Bias#Backward} + /** Creates position with a bias. If the bias is {@link javax.swing.text.Position.Bias#Backward Backward} * then if an insert occures at the position, the text is inserted - * after the position. If the bias is {@link javax.swing.text.Position.Bias#Forward Forward}, then the text is + * after the position. If the bias is {@link javax.swing.text.Position.Bias#Forward Forward}, then the text is * inserted before the position. * * @param offset the offset for the position diff --git a/platform/openide.text/src/org/openide/text/PositionBounds.java b/platform/openide.text/src/org/openide/text/PositionBounds.java index 5c12d27c5aa8..4bb2e6cd7a04 100644 --- a/platform/openide.text/src/org/openide/text/PositionBounds.java +++ b/platform/openide.text/src/org/openide/text/PositionBounds.java @@ -66,7 +66,7 @@ public PositionRef getEnd() { } /** Replaces the text contained in this range. - * This replacement is done atomically, and so is preferable to manual inserts & removes. + * This replacement is done atomically, and so is preferable to manual inserts & removes. *

          If you are running this from user-oriented code, you may want to wrap it in {@link NbDocument#runAtomicAsUser}. * @param text new text to insert over existing text * @exception IOException if any problem occurred during document loading (if that was necessary) diff --git a/platform/openide.text/src/org/openide/text/PrintPreferences.java b/platform/openide.text/src/org/openide/text/PrintPreferences.java index 3728f488b558..28580a20df25 100644 --- a/platform/openide.text/src/org/openide/text/PrintPreferences.java +++ b/platform/openide.text/src/org/openide/text/PrintPreferences.java @@ -278,7 +278,7 @@ public static float getLineAscentCorrection() { } /** - * @param correction the amount of vertical space to print between lines. + * @param correction the amount of vertical space to print between lines. * @exception IllegalArgumentException if correction is less than 0. */ public static void setLineAscentCorrection(float correction) { diff --git a/platform/openide.text/src/org/openide/text/UndoRedoManager.java b/platform/openide.text/src/org/openide/text/UndoRedoManager.java index dba99d2140e6..59866375d25b 100644 --- a/platform/openide.text/src/org/openide/text/UndoRedoManager.java +++ b/platform/openide.text/src/org/openide/text/UndoRedoManager.java @@ -29,11 +29,11 @@ /** * An improved version of UndoRedo manager that locks document before * doing any other operations. - *
          + *
          * It supports grouping of undoable edits by extending UndoGroupManager. - *
          + *
          * It supports save actions that produce a compound undoable edit. - *
          + *
          * *

          * Following requirements should be met: @@ -47,8 +47,6 @@ *

        • When save occurred inside UM.edits the extra save actions are kept separately and undone * when "coming out of the savepoint" and redone when "coming to a savepoint".
          • *
        - *

        - * *

        * Undo Grouping allows explicit control of what * UndoableEdits are coalesced into compound edits, rather than using @@ -64,7 +62,6 @@ * CompoundEdit and to continue accumulating; an application could do * this at strategic points, such as EndOfLine input or cursor movement.

        3. *
      - *

      * * @author Miloslav Metelka * @author Jaroslav Tulach diff --git a/platform/openide.windows/apichanges.xml b/platform/openide.windows/apichanges.xml index 268f9163af52..b105d89c73fe 100644 --- a/platform/openide.windows/apichanges.xml +++ b/platform/openide.windows/apichanges.xml @@ -836,7 +836,7 @@ Provided implementation of new window system. It is a new major version of module core/windows. There also open API affected. There were added some new APIs, some older were deprecated and also some older APIs have adjusted their semantics. Look at the - changes document + changes document which has the detailed information. diff --git a/platform/openide.windows/arch.xml b/platform/openide.windows/arch.xml index 2f4ec6cd1b7f..904f094c8fd6 100644 --- a/platform/openide.windows/arch.xml +++ b/platform/openide.windows/arch.xml @@ -96,20 +96,20 @@ November 15 2003.

      - + Cover of NetBeans Platform for Beginners book For general overview of the concepts, together with code samples, see chapter 6, - of NetBeans Platform for Beginners + of NetBeans Platform for Beginners by Jason Wexbridge and Walter Nyland.

      General usecases -can be read in the design document +can be read in the design document created before work on new window system design started. @@ -126,7 +126,7 @@ and cleanup the serialdata section - replace it with proper "<instance class

      - Q: I'm trying to make a TopComponentGroup. I've just read http://ui.netbeans.org/docs/ui/ws/ws_spec.html#3.9 + Q: I'm trying to make a TopComponentGroup. I've just read https://netbeans.apache.org/projects/ui/ws/ws_spec.html#s39 I want to make a group that uses the first invocation strategy. That is, I want the group to open/close when I activate a certain subclass of TopComponent. Say, for example, I have a FooTopComponent, and when it's active, @@ -143,7 +143,7 @@ and cleanup the serialdata section - replace it with proper "<instance class

      A:Yes it is correct way. You can check - simple test module. + simple test module. First you must get TopComponentGroup instance using find method then call TopComponentGroup.open()/close(). Here is the code in your componentDeactivated method: 
      @@ -237,11 +237,11 @@ It follows JLF standard for the custom UI components provided by core implementa
 Yes. Module stores its own versioned settings as XML files. In addition
 components are stored in settings file format of core/settings module.
 For description of current (version 2.0) configuration data folders see
-
+
 new configuration data here
 For description of old (version < 2.0) configuration data folders and how they are imported
 to new desktop layout see 
-
+
 old configuration data 
 
 
@@ -1422,9 +1422,9 @@ No.
 -->
 
 Module reads its own configuration from its layer and eventualy from other module layers
-if provided. Data have following folder structure.
-It contains Module folder structure under Windows2 directory 
-and Local folder structure under Windows2Local directory.
+if provided. Data have following folder structure.
+It contains Module folder structure under Windows2 directory 
+and Local folder structure under Windows2Local directory.
 
 
 
diff --git a/platform/openide.windows/src/org/openide/windows/CloneableOpenSupport.java b/platform/openide.windows/src/org/openide/windows/CloneableOpenSupport.java
index e831de5484fa..2c9fc0ef995f 100644
--- a/platform/openide.windows/src/org/openide/windows/CloneableOpenSupport.java
+++ b/platform/openide.windows/src/org/openide/windows/CloneableOpenSupport.java
@@ -307,7 +307,7 @@ public static interface Env extends java.io.Serializable {
         public CloneableOpenSupport findCloneableOpenSupport();
     }
 
-    /** Property change & veto listener. To react to dispose/delete of
+    /** Property change & veto listener. To react to dispose/delete of
     * the data object.
     */
     private static final class Listener extends CloneableTopComponent.Ref implements PropertyChangeListener,
diff --git a/platform/openide.windows/src/org/openide/windows/Mode.java b/platform/openide.windows/src/org/openide/windows/Mode.java
index ed32f33d24a4..801ecce9c170 100644
--- a/platform/openide.windows/src/org/openide/windows/Mode.java
+++ b/platform/openide.windows/src/org/openide/windows/Mode.java
@@ -34,12 +34,12 @@
  * Modules can add their own modes by declaring them using XML.
  * 
      
  * Modules can get a set of current modes by calling
- * {@link WindowManager#getModes}.
      
+ * {@link WindowManager#getModes}.
  *
  * 
      
  * Each mode must have a unique name.
  *
- * 
      
+ * 
      
  * Important note: Do not provide implementation of this interface unless you are window system provider!
  */
 public interface Mode extends Serializable {
@@ -134,7 +134,7 @@ public interface Mode extends Serializable {
     /**
      * Extension to provide exposure of XML configuration.
      * 
-     * @see http://wiki.apidesign.org/wiki/ExtendingInterfaces
+     * @see ExtendingInterfaces
      * @since 6.82
      */
     public interface Xml extends Mode {
diff --git a/platform/openide.windows/src/org/openide/windows/ModeSelector.java b/platform/openide.windows/src/org/openide/windows/ModeSelector.java
index 228d4fc4180e..b749c6b2cf73 100644
--- a/platform/openide.windows/src/org/openide/windows/ModeSelector.java
+++ b/platform/openide.windows/src/org/openide/windows/ModeSelector.java
@@ -25,11 +25,11 @@
  * the last-used editor-kind Mode, or the default editor mode if no editor was used.
  * Plugin implementors can hint the Window System to use more appropriate
  * mode than the default to open the TopComppnent. 
- * 
      
+ * 
      
  * If none of the registered {@code ModeSelector}s return a valid Mode, the TopComponent
  * will open in the mode selected by the default algorithm. Implementation of WindowManager 
  * may ignore the hint, for example if it conflicts with persisted settings or user choices.
- * 
      
+ * 
      
  * Implementations of {@code ModeSelector} must be registered in the default Lookup.
  * @since 6.77
  */
diff --git a/platform/openide.windows/src/org/openide/windows/ModeUtilities.java b/platform/openide.windows/src/org/openide/windows/ModeUtilities.java
index 2de0b7b81954..c9d6f4c4e35d 100644
--- a/platform/openide.windows/src/org/openide/windows/ModeUtilities.java
+++ b/platform/openide.windows/src/org/openide/windows/ModeUtilities.java
@@ -39,7 +39,7 @@
  * of TopComponents at shut-down time in the Windows2Local file system. Note also that 
  * this is not connected with the deprecated notion of {@link Workspace}.
  * 
- * @see http://wiki.apidesign.org/wiki/ExtendingInterfaces
+ * @see ExtendingInterfaces
  * 
  * @author Mark Phipps
  * @since 6.82
diff --git a/platform/openide.windows/src/org/openide/windows/OnShowing.java b/platform/openide.windows/src/org/openide/windows/OnShowing.java
index 6d29f7d2b828..f210cc27f65a 100644
--- a/platform/openide.windows/src/org/openide/windows/OnShowing.java
+++ b/platform/openide.windows/src/org/openide/windows/OnShowing.java
@@ -38,7 +38,7 @@
  *
      * * @since 6.54 - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> */ @NamedServiceDefinition( path="Modules/UIReady", // NOI18N diff --git a/platform/openide.windows/src/org/openide/windows/TopComponent.java b/platform/openide.windows/src/org/openide/windows/TopComponent.java index 6c6bc1631d56..3dbffd2b457c 100644 --- a/platform/openide.windows/src/org/openide/windows/TopComponent.java +++ b/platform/openide.windows/src/org/openide/windows/TopComponent.java @@ -797,7 +797,7 @@ protected void componentDeactivated() { * if it is not already. *

      Subclasses should override this method to transfer focus to desired * focusable component. TopComponent itself is not focusable. - * See for example {@link org.openide.text.CloneableEditor#requestFocus}. + * See for example CloneableEditor#requestFocus. *

      Note: Use {@link #requestActive} instead to make TopComponent active * in the window system (not only focused). This method should be considered deprecated * for calling from outside; but it may be overridden (inside of which you may call super). @@ -817,7 +817,7 @@ public void requestFocus() { * if it is not already. *

      Subclasses should override this method to transfer focus to desired * focusable component. TopComponent itself is not focusable. - * See for example {@link org.openide.text.CloneableEditor#requestFocusInWindow}. + * See for example CloneableEditor#requestFocusInWindow. *

      Note: Use {@link #requestActive} instead to make TopComponent active * in the window system (not only focused). This method should be considered deprecated * for calling from outside; but it may be overridden (inside of which you may call super). @@ -1305,7 +1305,7 @@ public String getToolTipText() { * an action just because focus is transferred from a component with a (potential) * node selection to a component that does not have node selections. *

      - * If you override the method in your subclass, the default activatedNodes<->lookup synchronization + * If you override the method in your subclass, the default activatedNodes<->lookup synchronization * will not be performed. That can influence functionality that relies on activated Nodes being present * in the TopComponent's lookup. If you want to preserve the synchronization, use {@link #associateLookup} * instead. diff --git a/platform/openide.windows/src/org/openide/windows/TopComponentGroup.java b/platform/openide.windows/src/org/openide/windows/TopComponentGroup.java index e155dbefabda..e9551faf1f87 100644 --- a/platform/openide.windows/src/org/openide/windows/TopComponentGroup.java +++ b/platform/openide.windows/src/org/openide/windows/TopComponentGroup.java @@ -23,10 +23,10 @@ /** * Represents window group. The notion of window group is defined by - * Window system UI specification document. - * The concept of window group explains API changes document. + * Window system UI specification document. + * The concept of window group explains API changes document. * - *

      + *

      * Importatnt note: Do not provide implementation of this interface unless you are window system provider! * * @author Peter Zavadsky diff --git a/platform/openide.windows/src/org/openide/windows/WindowManager.java b/platform/openide.windows/src/org/openide/windows/WindowManager.java index 7717b6c49daf..bbf60d948b10 100644 --- a/platform/openide.windows/src/org/openide/windows/WindowManager.java +++ b/platform/openide.windows/src/org/openide/windows/WindowManager.java @@ -40,7 +40,7 @@ * Manages window system. * Allows the work with window system components, i.e. Modes, TopComponentGroups * and provides handling of operations provided over TopComponents. - *

      + *

      * Important note: Do not provide implementation of this abstract class unless you are window system provider! * * @author Jaroslav Tulach @@ -668,20 +668,18 @@ public void removeWindowSystemListener( WindowSystemListener listener ) { *

    • Load new window layout from the given role.
      • *
    • Show the main window.
      • * - * The whole operation may take a few seconds to complete.

      + * The whole operation may take a few seconds to complete. *

      Windows that were opened in previous role but are not opened or present - * in the new role will receive TopComponent.componentClosed() notification.

      + * in the new role will receive TopComponent.componentClosed() notification. *

      Note: To keep the main window showing while switching the role, use the following branding: * org.netbeans.core.windows.WinSys.Show.Hide.MainWindow.While.Switching.Role=false - *

      *

      Note: Action org.netbeans.core.windows.actions.SwitchRoleKeepDocumentsAction * in Actions/Window layer folder can change the role too but it * also attempts to keep documents from previous role opened in the new role as well. * The new role name is ActionEvent.getActionCommand() argument. - *

      *

      If the window system has been already loaded then the method must be * called from EDT thread, otherwise it's safe to set the initial startup - * role in e.g. ModuleInstall.restored() method.

      + * role in e.g. ModuleInstall.restored() method. * @param roleName Name of the new role to switch to or null to switch * to the default window layout. * @since 6.43 diff --git a/platform/openide.windows/src/org/openide/windows/Workspace.java b/platform/openide.windows/src/org/openide/windows/Workspace.java index 1946a033cc74..1d6576047357 100644 --- a/platform/openide.windows/src/org/openide/windows/Workspace.java +++ b/platform/openide.windows/src/org/openide/windows/Workspace.java @@ -35,7 +35,7 @@ * When serialized only keeps "weak" reference to this workspace does not * stores the content of the workspace (it is responsibility of window manager). * - *

      + *

      * Important note: Do not provide implementation of this interface unless you are window system provider! * * @author Jaroslav Tulach diff --git a/platform/openide.windows/src/org/openide/windows/doc-files/api.html b/platform/openide.windows/src/org/openide/windows/doc-files/api.html index 123dbd0e03da..3e4cb0cad6db 100644 --- a/platform/openide.windows/src/org/openide/windows/doc-files/api.html +++ b/platform/openide.windows/src/org/openide/windows/doc-files/api.html @@ -26,7 +26,7 @@

      -Note: See the changes document. Window system implementation +Note: See the changes document. Window system implementation changed is major version. Comparing to the older version it has changed its laout significantly, introduced group, and released support of workspaces

      @@ -493,7 +493,7 @@

      Special support for serialization

      can return null findDefault should handle such case somehow eg. by calling of getDefault. There is a -simple example module +simple example module where persistent singleton instance is defined in module layer as described here.

      It is possible to use writeReplace and readResolve as well @@ -780,7 +780,7 @@

      Directory structure

      -   See Structure of configuration data.
+   See Structure of configuration data.
      diff --git a/platform/sendopts/apichanges.xml b/platform/sendopts/apichanges.xml index de16ffc7d9cf..9221c15a8740 100644 --- a/platform/sendopts/apichanges.xml +++ b/platform/sendopts/apichanges.xml @@ -126,7 +126,7 @@ - After the review from others + After the review from others it has been decided to de-generify the interfaces. As a result of this complete rewrite, the API clients need to be fully rewritten as most of the method signatures changed. diff --git a/platform/sendopts/arch.xml b/platform/sendopts/arch.xml index 09dfa6048fe5..bf334568d556 100644 --- a/platform/sendopts/arch.xml +++ b/platform/sendopts/arch.xml @@ -300,7 +300,7 @@ public final class MyOption implements R identified by some additional option, so when the shared option appears the infrastructure knows which processor to delegate to. This is demonstrated in the - + SharedOptionTest which basically does the following:

      diff --git a/platform/sendopts/src/org/netbeans/spi/sendopts/Arg.java b/platform/sendopts/src/org/netbeans/spi/sendopts/Arg.java index 81006db62d44..545bfa806390 100644 --- a/platform/sendopts/src/org/netbeans/spi/sendopts/Arg.java +++ b/platform/sendopts/src/org/netbeans/spi/sendopts/Arg.java @@ -59,7 +59,7 @@ * } * } * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> * @since 2.20 */ @Retention(RetentionPolicy.RUNTIME) diff --git a/platform/sendopts/src/org/netbeans/spi/sendopts/ArgsProcessor.java b/platform/sendopts/src/org/netbeans/spi/sendopts/ArgsProcessor.java index 31986116c28d..4cab7a15cacb 100644 --- a/platform/sendopts/src/org/netbeans/spi/sendopts/ArgsProcessor.java +++ b/platform/sendopts/src/org/netbeans/spi/sendopts/ArgsProcessor.java @@ -32,7 +32,7 @@ * use the platform. *

      * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> * @since 2.20 */ public interface ArgsProcessor { diff --git a/platform/sendopts/src/org/netbeans/spi/sendopts/Description.java b/platform/sendopts/src/org/netbeans/spi/sendopts/Description.java index 95e62340311d..83dcc3455096 100644 --- a/platform/sendopts/src/org/netbeans/spi/sendopts/Description.java +++ b/platform/sendopts/src/org/netbeans/spi/sendopts/Description.java @@ -28,7 +28,7 @@ * Can be attached to public non-static fields that are also annotated * by {@code @}{@link Arg}. * - * @author Jaroslav Tulach + * @author Jaroslav Tulach <jtulach@netbeans.org> * @since 2.20 */ @Target({ElementType.FIELD}) diff --git a/platform/sendopts/src/org/netbeans/spi/sendopts/Option.java b/platform/sendopts/src/org/netbeans/spi/sendopts/Option.java index 0c5a55c0bb9b..d7f40de7ba95 100644 --- a/platform/sendopts/src/org/netbeans/spi/sendopts/Option.java +++ b/platform/sendopts/src/org/netbeans/spi/sendopts/Option.java @@ -217,7 +217,7 @@ public static Option requiredArgument(char shortName, String longName) { return new Option(shortName, longName, 2); } - /** Creates an option that can accept additional arguments. + /** Creates an option that can accept additional arguments. * For example to have option that opens few files * one could write:
            * Option openOption = Option.additionalArguments('o', "open");
      @@ -241,8 +241,8 @@ public static Option requiredArgument(char shortName, String longName) { * { "X.java", "Y.java", "Z.txt" }. *

      * Obviously only one such {@link Option#additionalArguments} can be - * used at once on a command line. If there was not only the open - * but also edit option + * used at once on a command line. If there was not only the open + * but also edit option * taking the additional arguments, * then command line like: 

            * --edit X.java --open Y.java Z.txt
      @@ -254,7 +254,7 @@ public static Option requiredArgument(char shortName, String longName) { public static Option additionalArguments(char shortName, String longName) { return new Option(shortName, longName, 3); } - /** Creates a default option that accepts additional arguments + /** Creates a default option that accepts additional arguments * not claimed by any other option. * For example to have option that opens few files * one could write:
      @@ -298,7 +298,7 @@ public static Option defaultArguments() {
     /** Creates an option that is always present. This can be useful for
      * processors that want to be notified everytime the command line
      * is successfuly parsed. 
-     * 
+     * 
            * Option always = Option.always();
       
      * and inside of the {@link OptionProcessor} declaring this
      * option use:
      diff --git a/platform/sendopts/src/org/netbeans/spi/sendopts/OptionGroups.java b/platform/sendopts/src/org/netbeans/spi/sendopts/OptionGroups.java
index 21a89d3dd617..36c9e304b8e6 100644
--- a/platform/sendopts/src/org/netbeans/spi/sendopts/OptionGroups.java
+++ b/platform/sendopts/src/org/netbeans/spi/sendopts/OptionGroups.java
@@ -31,12 +31,13 @@
  * arguments to each method. The Min and Max shown the
  * number that is needed for the group option to be "consistent":
  * 
- * 
- *   
- *     
- *     
- *     
- *   
+ * 
      MethodMinMax
      
+ * 
+ *   
+ *     
+ *     
+ *     
+ *   
  * 
  *   
  *     
@@ -90,7 +91,7 @@ private OptionGroups() {
      * can then be processed one by one.
      * 
      * @param options the sub options to check on the command line
-     * @return compound option that is activated if at least one of the
+     * @return compound option that is activated if at least one of the
      *    options appears on the command line
      */
     public static Option someOf(Option... options) {
@@ -105,7 +106,7 @@ public static Option someOf(Option... options) {
      * with associated value of new String[0].
      * 
      * @param options the sub options to check on the command line
-     * @return compound option that is activated if at least one of the
+     * @return compound option that is activated if at least one of the
      *    options appears on the command line
      */
     public static Option anyOf(Option... options) {
diff --git a/platform/settings/src/org/netbeans/api/settings/ConvertAsJavaBean.java b/platform/settings/src/org/netbeans/api/settings/ConvertAsJavaBean.java
index 47882eab1de0..768b40ee00bc 100644
--- a/platform/settings/src/org/netbeans/api/settings/ConvertAsJavaBean.java
+++ b/platform/settings/src/org/netbeans/api/settings/ConvertAsJavaBean.java
@@ -47,7 +47,7 @@
  * starts to listen on existing objects and in case a property change
  * is delivered, the new state of the object is persisted again.
  *
- * @author Jaroslav Tulach 
+ * @author Jaroslav Tulach <jtulach@netbeans.org>
  * @since 1.20
  */
 @Retention(RetentionPolicy.SOURCE)
diff --git a/platform/settings/src/org/netbeans/api/settings/ConvertAsProperties.java b/platform/settings/src/org/netbeans/api/settings/ConvertAsProperties.java
index f3651f154f8e..874e12f3fc4f 100644
--- a/platform/settings/src/org/netbeans/api/settings/ConvertAsProperties.java
+++ b/platform/settings/src/org/netbeans/api/settings/ConvertAsProperties.java
@@ -42,7 +42,7 @@
  * }
  * 
  *
- * @author Jaroslav Tulach 
+ * @author Jaroslav Tulach <jtulach@netbeans.org>
  * @since 1.18
  */
 @Retention(RetentionPolicy.SOURCE)
diff --git a/platform/settings/src/org/netbeans/api/settings/FactoryMethod.java b/platform/settings/src/org/netbeans/api/settings/FactoryMethod.java
index 1bd1420bf294..58bed327e510 100644
--- a/platform/settings/src/org/netbeans/api/settings/FactoryMethod.java
+++ b/platform/settings/src/org/netbeans/api/settings/FactoryMethod.java
@@ -30,7 +30,7 @@
  * {@link Convertor}s.
  * 
  * @since 1.40
- * @author Jaroslav Tulach 
+ * @author Jaroslav Tulach <jtulach@netbeans.org>
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
diff --git a/platform/settings/src/org/netbeans/spi/settings/DOMConvertor.java b/platform/settings/src/org/netbeans/spi/settings/DOMConvertor.java
index 255859e0a4bf..435d9d69f8b4 100644
--- a/platform/settings/src/org/netbeans/spi/settings/DOMConvertor.java
+++ b/platform/settings/src/org/netbeans/spi/settings/DOMConvertor.java
@@ -224,7 +224,7 @@ protected static final Object delegateRead(org.w3c.dom.Element element) throws j
         return obj;
     }
     
-    /** delegate the write operation to a convertor able to write obj.
+    /** delegate the write operation to a convertor able to write obj.
      * @param doc a DOM document allowing to create elements describing passed object
      * @param obj an object to convert
      * @return a DOM element representation
diff --git a/webcommon/api.knockout/arch.xml b/webcommon/api.knockout/arch.xml
index 7dee84ba7c08..4e8a8910235a 100644
--- a/webcommon/api.knockout/arch.xml
+++ b/webcommon/api.knockout/arch.xml
@@ -120,11 +120,11 @@
 
      
 This is the code to register a sample provider:
 
      
-
      -{@code @}ServiceProvider(service = BindingsProvider.class)
-public class SampleBindingsProvider implements {@link org.netbeans.spi.knockout.BindingsProvider} {
-    {@code @Override}
-    public void findBindings(FileObject htmlFile, Response r) {
+
      
+@ServiceProvider(service = BindingsProvider.class)
+public class SampleBindingsProvider implements org.netbeans.spi.knockout.BindingsProvider {
+    @Override
+    public void findBindings(FileObject htmlFile) {
         Bindings tweet = Bindings.create("Tweet").
                 stringProperty("from_user", false).
                 intProperty("from_user_id", false);
@@ -142,10 +142,10 @@ public class SampleBindingsProvider implements {@link org.netbeans.spi.knockout.
                 modelProperty("currentTweets", tweet, true).
                 modelProperty("savedLists", tweeters, true);
 
-        r.applyBindings(twitterClient);
+        return Response.create(twitterClient);
     }
 }
-
      
+
      
 
 
      
 This sample has been used when testing the module.
diff --git a/webcommon/api.knockout/src/org/netbeans/spi/knockout/Bindings.java b/webcommon/api.knockout/src/org/netbeans/spi/knockout/Bindings.java
index 2a04676d0a30..4335373a5a3c 100644
--- a/webcommon/api.knockout/src/org/netbeans/spi/knockout/Bindings.java
+++ b/webcommon/api.knockout/src/org/netbeans/spi/knockout/Bindings.java
@@ -38,9 +38,9 @@
  * Register as {@link BindingsProvider}. When called build description of JSON
  * types using methods like {@link #stringProperty(java.lang.String, boolean)}
  * and then pass the result into
- * {@link Response#applyBindings(org.netbeans.spi.knockout.Bindings)} method.
+ * {@link Response#create(Bindings)} method.
  *
- * @author Jaroslav Tulach 
+ * @author Jaroslav Tulach <jtulach@netbeans.org>
  */
 public final class Bindings {
 
diff --git a/webcommon/api.knockout/src/org/netbeans/spi/knockout/BindingsProvider.java b/webcommon/api.knockout/src/org/netbeans/spi/knockout/BindingsProvider.java
index cd9eba801280..956f46fd3085 100644
--- a/webcommon/api.knockout/src/org/netbeans/spi/knockout/BindingsProvider.java
+++ b/webcommon/api.knockout/src/org/netbeans/spi/knockout/BindingsProvider.java
@@ -25,12 +25,12 @@
  * A provider that knows more about structure of Knockout bindings in an HTML
  * page. Providers should be registered by {@link ServiceProvider} annotation so
  * they can be found for a particular HTML file. Their
- * {@link #findBindings(org.openide.filesystems.FileObject, org.netbeans.spi.knockout.BindingsProvider.Response) findBindings}
+ * {@link #findBindings(org.openide.filesystems.FileObject) findBindings}
  * method is called when a knockout code completion is about to be shown in the
  * HTML editor and then can generate a JSON like description of the structure of
  * knockout context via {@link Bindings} methods.
  *
- * @author Jaroslav Tulach 
+ * @author Jaroslav Tulach <jtulach@netbeans.org>
  */
 public interface BindingsProvider {
 
@@ -44,7 +44,7 @@ public interface BindingsProvider {
 
     /**
      * Methods for {@link BindingsProvider}s to provide a response when
-     * {@link BindingsProvider#findBindings(org.openide.filesystems.FileObject, org.netbeans.spi.knockout.BindingsProvider.Response) queries}
+     * {@link BindingsProvider#findBindings(org.openide.filesystems.FileObject) queries}
      * about a particular HTML file.
      */
     public static final class Response {
diff --git a/webcommon/api.knockout/src/org/netbeans/spi/knockout/package.html b/webcommon/api.knockout/src/org/netbeans/spi/knockout/package.html
index 4e7f59a81da8..703782865cfb 100644
--- a/webcommon/api.knockout/src/org/netbeans/spi/knockout/package.html
+++ b/webcommon/api.knockout/src/org/netbeans/spi/knockout/package.html
@@ -21,7 +21,7 @@
 -->
 
     
-        
      Java {@link org.netbeans.spi.knockout.Bindings model class} to describe JSON-like Knockout bindings and
+        
      Java {@link org.netbeans.spi.knockout.Bindings model class} to describe JSON-like Knockout bindings and
             register {@link org.netbeans.spi.knockout.BindingsProvider a provider} used by the editor infrastructure
             to query for the {@link org.netbeans.spi.knockout.Bindings model}.
         
      

      Behaviour overview
      MethodMinMax
      {@link OptionGroups#allOf}