Skip to content

Commit

Permalink
apidoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ebarboni committed Mar 24, 2023
1 parent 4c90ff3 commit fff178d
Show file tree
Hide file tree
Showing 191 changed files with 507 additions and 512 deletions.
2 changes: 1 addition & 1 deletion ide/api.debugger/apichanges.xml
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@
<p>
In order to be able to register debugger services on System FileSystem,
which brings more flexibility and better performance (see also
<a href="http://www.netbeans.org/issues/show_bug.cgi?id=153093#desc7"/>),
<a href="https://bz.apache.org/netbeans/show_bug.cgi?id=153093#desc7"/>),
we add non-recursive content of <code>org.openide.util.Lookups.forPath()</code>
into debugger lookup.
Since debugger needs retrieve context-aware services from the lookup,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>#canPostAsynchronously}</code> returns true.
* Otherwise it behaves like {@link #doAction}.
* The returned task, or
* {@link ActionsManagerListener} can be used to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public final synchronized int getHitCountFilter() {

/**
* Get the style of hit count filtering.
* @return the style of hit count filtering, or <cpde>null</code> when no count filter is set.
* @return the style of hit count filtering, or <code>null</code> when no count filter is set.
*/
public final synchronized HIT_COUNT_FILTERING_STYLE getHitCountFilteringStyle() {
return hitCountFilteringStyle;
Expand Down Expand Up @@ -285,7 +285,7 @@ public void setBreakpointsToEnable(@NonNull Set<Breakpoint> breakpointsToEnable)
* <p>
* 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@
* It provides root of threads hierarchy (call stacks, locals)
* and manages debugger actions.
*
* <p><br><table border="1" cellpadding="3" cellspacing="0" width="100%">
* <tbody><tr bgcolor="#ccccff">
* <td colspan="2"><font size="+2"><b>Description </b></font></td>
* <table>
* <caption>Description of DebuggerEngine</caption>
* <tbody><tr>
* <td colspan="2" style="background-color:#4D7A97"><font size="+2"><b>Description </b></font></td>
* </tr><tr><td align="left" valign="top" width="1%"><font size="+1">
* <b>Functionality</b></font></td><td>
*
Expand All @@ -52,8 +53,8 @@
* <br>
* <b>Support for aditional services:</b>
* 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:
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,14 @@
* {@link org.netbeans.api.debugger.Watch}es.
*
*
* <p><br><table border="1" cellpadding="3" cellspacing="0" width="100%">
* <tbody><tr bgcolor="#ccccff">
* <td colspan="2"><font size="+2"><b>Description </b></font></td>
* <table>
* <caption>Description of DebuggerManager</caption>
* <tbody><tr>
* <td colspan="2" style="background-color:#4D7A97"><font size="+2"><b>Description </b></font></td>
* </tr><tr><td align="left" valign="top" width="1%"><font size="+1">
* <b>Functionality</b></font></td><td>
*
* <b>Start & finish debugging:</b>
* <b>Start &amp; finish debugging:</b>
* 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
Expand Down Expand Up @@ -89,7 +90,7 @@
* <br><br>
* <b>Watches management:</b>
* DebuggerManager keeps list of all shared watches ({@link #getWatches}).
* Watch can be created & added ({@link #createWatch}).
* Watch can be created &amp; added ({@link #createWatch}).
*
* <br><br>
* <b>Support for listening:</b>
Expand Down Expand Up @@ -227,7 +228,7 @@ public <T> T lookupFirst(String folder, Class<T> 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
Expand Down Expand Up @@ -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
* <code>(index < 0 || index > getWatches().length)</code>
* <code>(index &lt; 0 || index &gt; getWatches().length)</code>
* @since 1.22
*/
public Watch createWatch (int index, String expr) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ public void breakpointRemoved (Breakpoint breakpoint) {
/**
* Called when set of watches is initialized.
*
* @return initial set of watches
*/
public void initWatches () {
}
Expand Down
11 changes: 6 additions & 5 deletions ide/api.debugger/src/org/netbeans/api/debugger/Session.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@
* be simple bean with properties like process ID, session name, etc.
* All other functionality is delegated to current debugger engine.
*
* <p><br><table border="1" cellpadding="3" cellspacing="0" width="100%">
* <tbody><tr bgcolor="#ccccff">
* <td colspan="2"><font size="+2"><b>Description </b></font></td>
* <table>
* <caption>Description of Session</caption>
* <tbody><tr>
* <td colspan="2" style="background-color:#4D7A97"><font size="+2"><b>Description </b></font></td>
* </tr><tr><td align="left" valign="top" width="1%"><font size="+1">
* <b>Functionality</b></font></td><td>
*
Expand Down Expand Up @@ -62,8 +63,8 @@
* <br><br>
* <b>Support for additional services:</b>
* 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:
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* <p/>
* <p>
* 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.
Expand Down Expand Up @@ -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 <code>true</code> when the session is changed and another session
* decided to perform the given action.<br/>
* decided to perform the given action.<br>
* <code>false</code> when no other session would like to perform this action.
*/
public boolean suggestChange(Session origin, String action, Map<Object, Object> properties) {
Expand Down Expand Up @@ -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 <code>null<code> when this handler decides
* @return A new session, or <code>null</code> when this handler decides
* not to change the debug session for this action.
*/
Session changeSuggested(Session origin, String action, Map<Object, Object> properties);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* &lt;/file&gt;
* &lt;/folder&gt;</pre>
*
* <br/>
* <br>
*
* @author Martin Entlicher
* @since 1.16
Expand Down
2 changes: 1 addition & 1 deletion ide/editor.settings.storage/apichanges.xml
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ is the proper place.
<description>
<p>
The phase 1 of the editor settings enhancements, please see
<a href="http://www.netbeans.org/issues/show_bug.cgi?id=90403">issue 90403</a>
<a href="https://bz.apache.org/netbeans/show_bug.cgi?id=90403">issue 90403</a>
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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

/**
* This singleton class contains access methods for editor settings like
* font & colors profiles and keymaps.
* font &amp; colors profiles and keymaps.
*
* @author Jan Jancura
*/
Expand Down Expand Up @@ -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 &amp; colors profiles.
*
* @return set of font & colors profiles
* @return set of font &amp; colors profiles
*/
public abstract Set<String> getFontColorProfiles ();

Expand All @@ -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 &amp; colors profile.
*
* @return name of current font & colors profile
* @return name of current font &amp; colors profile
*/
public abstract String getCurrentFontColorProfile ();

/**
* Sets current font & colors profile.
* Sets current font &amp; 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 &amp; 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 &amp; color defaults for given profile or null
*
* @deprecated Use getFontColorSettings(new String[0]).getAllFontColors(profile) instead.
*/
Expand All @@ -146,11 +146,11 @@ public abstract Collection<AttributeSet> getDefaultFontColors (
);

/**
* Returns default values for font & color defaults for given profile
* Returns default values for font &amp; 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 &amp; color defaults for given profile or null
*
* @deprecated Use getFontColorSettings(new String[0]).getAllFontColorsDefaults(profile) instead.
*/
Expand All @@ -160,10 +160,10 @@ public abstract Collection<AttributeSet> getDefaultFontColorDefaults (
);

/**
* Sets font & color defaults for given profile.
* Sets font &amp; color defaults for given profile.
*
* @param profile a profile name
* @param fontColors font & color defaults to be used
* @param fontColors font &amp; color defaults to be used
*
* @deprecated Use getFontColorSettings(new String[0]).setAllFontColors(profile, fontColors) instead.
*/
Expand Down Expand Up @@ -267,7 +267,7 @@ public abstract void setAnnotations (
/**
* Returns set of keymap profiles.
*
* @return set of font & colors profiles
* @return set of font &amp; colors profiles
*/
public abstract Set<String> getKeyMapProfiles ();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 &amp; color editor profiles. Instances of this
* class should be registered in <code>MimeLookup</code> for particular mime types.
*
* @author Jan Jancura
Expand All @@ -41,12 +41,12 @@ public abstract class FontColorSettingsFactory {
public abstract Collection<AttributeSet> getAllFontColors (String profile);

/**
* Gets default values for all font & colors for given profile, or null
* Gets default values for all font &amp; 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 &amp; colors
*/
public abstract Collection<AttributeSet> getAllFontColorDefaults
(String profile);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,22 @@ public static String getLocalizingBundleMessage(FileObject fo, String key, Strin
/**
* Converts a list of <code>KeyStroke</code>s to its textual representation. There
* are two available formats for the textual representation:
*
* <ul>
* <li><b>Human readable</b> - this format encodes a <code>KeyStroke</code> to
* a string that looks like for example 'Ctrl+A' or 'Alt+Shift+M'.
* <li><b>Emacs style</b> - this format encodes a <code>KeyStroke</code> to
* a string that's known from Emacs and that looks like for example 'C-A' or 'AS-M'.
* It uses methods from <code>org.openide.util.Utilities</code>, which take
* care of Mac OS specifics and use 'D' and 'O' wildcards for encoding 'Ctrl'
* and 'Alt' keys.
*
* </ul>
* @param keys The <code>KeyStrokes</code> to convert.
* @param emacsStyle If <code>true</code> the returned string will be in so called
* Emacs style, ortherwise it will be in human readable format.
*
* @return The textual representation of <code>KeyStroke</code>s 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<? extends KeyStroke> keys, boolean emacsStyle) {
if (!emacsStyle) {
Expand All @@ -84,7 +84,7 @@ public static String keyStrokesToString(Collection<? extends KeyStroke> keys, bo

/**
* Converts a textual representation of key strokes to an array of <code>KeyStroke</code>
* objects. Please see {@link #keyStrokesToString(Collection<KeyStroke>, 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ private Symbol(String name, String type, String description) {
}

/**
* Get the symbol name. Never <code>null<code>.
* Get the symbol name. Never <code>null</code>.
*
* @since 0.2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ private CompletableFuture<Void> 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<Void> attach(String executablePath, long processId, String debugger, Consumer<DebuggerEngine> startedEngine) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ default CompletableFuture<Void> 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<Void> attach(String executablePath, long processId, String debugger, Consumer<DebuggerEngine> startedEngine) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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}.
Expand Down Expand Up @@ -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 <a href="https://github.com/apache/netbeans/tree/master/ide/parsing.indexing/src/org/netbeans/modules/parsing/impl/indexing/Util.java">getAllMimeTypes</a>.
* Then accepts only text/* MIME type and specific hardcoded application/ MIME types.
*
* @param mimeType the MIME type to check
Expand Down
Loading

0 comments on commit fff178d

Please sign in to comment.