Skip to content

Commit aca0bf3

Browse files
committed
javadoc fixed
1 parent cd73f8b commit aca0bf3

File tree

34 files changed

+103
-107
lines changed

34 files changed

+103
-107
lines changed

visualvm/caching.api/src/org/graalvm/visualvm/api/caching/Cache.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
*/
3535
abstract public class Cache<K,V> {
3636
/**
37-
* Retrieves an object from the cache by the given key<br/>
38-
* If there is no cached version of the object {@linkplain #cacheMiss(java.lang.Object) } is invoked
37+
* Retrieves an object from the cache by the given key<br>
38+
* If there is no cached version of the object {@linkplain EntryFactory#createEntry(Object)} is invoked
3939
* <p>
4040
* To obtain a cache one needs to call one of {@linkplain CacheFactory} methods
4141
* </p>

visualvm/libs.profiler/lib.profiler.charts/src/org/graalvm/visualvm/lib/charts/canvas/BufferedCanvasComponent.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ protected final void invalidateImage() {
230230
* Marks part of the offscreen image as invalid. Invalid area of the image
231231
* will be updated on next paintComponent(Graphics) invocation.
232232
*
233-
* @param dirtyRect the part of the offscreen image to be marked as invalid.
233+
* @param invalidArea the part of the offscreen image to be marked as invalid.
234234
*/
235235
protected final void invalidateImage(Rectangle invalidArea) {
236236
if (invalidArea.isEmpty()) return;

visualvm/libs.profiler/lib.profiler.common/src/org/graalvm/visualvm/lib/common/Profiler.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,12 @@ public static synchronized Profiler getDefault() {
116116
* @param port Port number to be used to communicate with the agent
117117
* @param agentId Expected agent Id
118118
* @return the state of the agent
119-
* @see CommonConstants.AGENT_STATE_CONNECTED
120-
* @see CommonConstants.AGENT_STATE_DIFFERENT_ID
121-
* @see CommonConstants.AGENT_STATE_NOT_RUNNING
122-
* @see CommonConstants.AGENT_STATE_OTHER_SESSION_IN_PROGRESS
123-
* @see CommonConstants.AGENT_STATE_READY_DIRECT
124-
* @see CommonConstants.AGENT_STATE_READY_DYNAMIC
119+
* @see CommonConstants#AGENT_STATE_CONNECTED
120+
* @see CommonConstants#AGENT_STATE_DIFFERENT_ID
121+
* @see CommonConstants#AGENT_STATE_NOT_RUNNING
122+
* @see CommonConstants#AGENT_STATE_OTHER_SESSION_IN_PROGRESS
123+
* @see CommonConstants#AGENT_STATE_READY_DIRECT
124+
* @see CommonConstants#AGENT_STATE_READY_DYNAMIC
125125
*/
126126
public abstract int getAgentState(String host, int port, int agentId);
127127

visualvm/libs.profiler/lib.profiler.common/src/org/graalvm/visualvm/lib/common/ProfilingSettings.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,9 @@ public int getAllocTrackEvery() {
239239
}
240240

241241
/** @param cpuProfilingType Type of CPU instrumentation.
242-
* @see CommonConstants.CPU_INSTR_FULL
243-
* @see CommonConstants.CPU_INSTR_SAMPLED
244-
* @see CommonConstants.CPU_SAMPLED
242+
* @see CommonConstants#CPU_INSTR_FULL
243+
* @see CommonConstants#CPU_INSTR_SAMPLED
244+
* @see CommonConstants#CPU_SAMPLED
245245
*/
246246
public void setCPUProfilingType(final int cpuProfilingType) {
247247
this.cpuProfilingType = cpuProfilingType;
@@ -250,9 +250,9 @@ public void setCPUProfilingType(final int cpuProfilingType) {
250250
// -- General CPU Profiling settings ---------------------------------------------------------------------------------
251251

252252
/** @return Type of CPU instrumentation
253-
* @see CommonConstants.CPU_INSTR_FULL
254-
* @see CommonConstants.CPU_INSTR_SAMPLED
255-
* @see CommonConstants.CPU_SAMPLED
253+
* @see CommonConstants#CPU_INSTR_FULL
254+
* @see CommonConstants#CPU_INSTR_SAMPLED
255+
* @see CommonConstants#CPU_SAMPLED
256256
*/
257257
public int getCPUProfilingType() {
258258
return cpuProfilingType;

visualvm/libs.profiler/lib.profiler.ui/src/org/graalvm/visualvm/lib/ui/UIUtils.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ public void paint(Graphics g) {
152152
return separator;
153153
}
154154

155-
/** Determines if current L&F is AquaLookAndFeel */
155+
/** Determines if current L&amp;F is AquaLookAndFeel */
156156
public static boolean isAquaLookAndFeel() {
157157
// is current L&F some kind of AquaLookAndFeel?
158158
return UIManager.getLookAndFeel().getID().equals("Aqua"); //NOI18N
@@ -197,31 +197,31 @@ public static int getDefaultRowHeight() {
197197
return new JLabel("X").getPreferredSize().height + 2; //NOI18N
198198
}
199199

200-
/** Determines if current L&F is GTKLookAndFeel */
200+
/** Determines if current L&amp;F is GTKLookAndFeel */
201201
public static boolean isGTKLookAndFeel() {
202202
// is current L&F some kind of GTKLookAndFeel?
203203
return UIManager.getLookAndFeel().getID().equals("GTK"); //NOI18N
204204
}
205205

206-
/** Determines if current L&F is Nimbus */
206+
/** Determines if current L&amp;F is Nimbus */
207207
public static boolean isNimbusLookAndFeel() {
208208
// is current L&F Nimbus?
209209
return UIManager.getLookAndFeel().getID().equals("Nimbus"); //NOI18N
210210
}
211211

212-
/** Determines if current L&F is GTK using Nimbus theme */
212+
/** Determines if current L&amp;F is GTK using Nimbus theme */
213213
public static boolean isNimbusGTKTheme() {
214214
// is current L&F GTK using Nimbus theme?
215215
return isGTKLookAndFeel() && "nimbus".equals(Toolkit.getDefaultToolkit().getDesktopProperty("gnome.Net/ThemeName")); //NOI18N
216216
}
217217

218-
/** Determines if current L&F is Nimbus or GTK with Nimbus theme*/
218+
/** Determines if current L&amp;F is Nimbus or GTK with Nimbus theme*/
219219
public static boolean isNimbus() {
220220
// is current L&F Nimbus or GTK with Nimbus theme?
221221
return isNimbusLookAndFeel() || isNimbusGTKTheme();
222222
}
223223

224-
/** Determines if current L&F is MetalLookAndFeel */
224+
/** Determines if current L&amp;F is MetalLookAndFeel */
225225
public static boolean isMetalLookAndFeel() {
226226
// is current L&F some kind of MetalLookAndFeel?
227227
return UIManager.getLookAndFeel().getID().equals("Metal"); //NOI18N
@@ -421,7 +421,7 @@ public static boolean isDarkResultsBackground() {
421421
return darkResultsBackground;
422422
}
423423

424-
/** Determines if current L&F is Windows Classic LookAndFeel */
424+
/** Determines if current L&amp;F is Windows Classic LookAndFeel */
425425
public static boolean isWindowsClassicLookAndFeel() {
426426
if ("Windows Classic".equals(UIManager.getLookAndFeel().getName())) return true; //NOI18N
427427

@@ -432,13 +432,13 @@ public static boolean isWindowsClassicLookAndFeel() {
432432
return (!isWindowsXPLookAndFeel());
433433
}
434434

435-
/** Determines if current L&F is WindowsLookAndFeel */
435+
/** Determines if current L&amp;F is WindowsLookAndFeel */
436436
public static boolean isWindowsLookAndFeel() {
437437
// is current L&F some kind of WindowsLookAndFeel?
438438
return UIManager.getLookAndFeel().getID().equals("Windows"); //NOI18N
439439
}
440440

441-
/** Determines if current L&F is Windows XP LookAndFeel */
441+
/** Determines if current L&amp;F is Windows XP LookAndFeel */
442442
public static boolean isWindowsXPLookAndFeel() {
443443
if (!isWindowsLookAndFeel()) {
444444
return false;
@@ -467,7 +467,7 @@ public static boolean isOracleLookAndFeel() {
467467
/** Checks give TreePath for the last node, and if it ends with a node with just one child,
468468
* it keeps expanding further.
469469
* Current implementation expands through the first child that is not leaf. To more correctly
470-
* fulfil expected semantics in case maxChildToExpand is > 1, it should expand all paths through
470+
* fulfill expected semantics in case maxChildToExpand is &gt; 1, it should expand all paths through
471471
* all children.
472472
*
473473
* @param tree
@@ -600,7 +600,7 @@ public void componentResized(ComponentEvent e) {
600600
// Also fixes buttons size in JToolbar.
601601

602602
/** Ensures that focus will be really painted if button is focused
603-
* and fixes using custom border for JDK 1.5 & XP LaF
603+
* and fixes using custom border for JDK 1.5 &amp; XP L&amp;F
604604
*/
605605
public static void fixButtonUI(AbstractButton button) {
606606
// Doesn't seem to be necessary any more, conflicts with Jigsaw

visualvm/libs.profiler/lib.profiler.ui/src/org/graalvm/visualvm/lib/ui/components/FlatToolBar.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,8 @@ public FlatToolBar() {
189189
/**
190190
* Creates a toolbar with specified orientation and horizontal button style (i.e. icon left to text)
191191
*
192-
* @see JToolBar.HORIZONTAL
193-
* @see JToolBar.VERTICAL
192+
* @see JToolBar#HORIZONTAL
193+
* @see JToolBar#VERTICAL
194194
* @param orientation
195195
*/
196196
public FlatToolBar(int orientation) {
@@ -200,8 +200,8 @@ public FlatToolBar(int orientation) {
200200
/**
201201
* Creates a toolbar with specified orientation and button style
202202
*
203-
* @see JToolBar.HORIZONTAL
204-
* @see JToolBar.VERTICAL
203+
* @see JToolBar#HORIZONTAL
204+
* @see JToolBar#VERTICAL
205205
*
206206
* @param orientation
207207
* @param buttonStyle

visualvm/libs.profiler/lib.profiler.ui/src/org/graalvm/visualvm/lib/ui/components/JExtendedTable.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
/**
3939
* This class implements JTable with extended CellTip support.
40-
* Added support for handling Home & End keys.
40+
* Added support for handling Home &amp; End keys.
4141
*
4242
* @author Tomas Hurka
4343
* @author Jiri Sedlacek

visualvm/libs.profiler/lib.profiler.ui/src/org/graalvm/visualvm/lib/ui/components/treetable/AbstractTreeTableModel.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public AbstractTreeTableModel(CCTNode root, boolean supportsSorting, int sorting
6868

6969
/**
7070
* Returns the child at index 'num' of the given node.
71-
* <p/>
71+
* <p>
7272
* Although the method expects an Object because of the TreeModel contract,
7373
* in reality it assumes the given node is a 'TreeTableNode'.
7474
*
@@ -80,7 +80,7 @@ public Object getChild(Object node, int num) {
8080

8181
/**
8282
* Returns the number of children a given node has.
83-
* <p/>
83+
* <p>
8484
* Although the method expects an Object because of the TreeModel contract,
8585
* in reality it assumes the given node is a 'TreeTableNode'.
8686
*
@@ -112,7 +112,7 @@ public String getColumnToolTipText(int column) {
112112

113113
/**
114114
* Returns the index of the child node in the parent node.
115-
* <p/>
115+
* <p>
116116
* Although the method expects Objects because of the TreeModel contract,
117117
* it assumes both parent and child are TreeTableNodes.
118118
*/
@@ -144,7 +144,7 @@ public boolean getInitialSortingOrder() {
144144

145145
/**
146146
* Returns true when the given node is a 'leaf'.
147-
* <p/>
147+
* <p>
148148
* Although the method expects an Object because of the TreeModel contract,
149149
* in reality it assumes the given node is a 'TreeTableNode'.
150150
*
@@ -336,7 +336,7 @@ public boolean supportsSorting() {
336336

337337
/**
338338
* Overwrite if you are going to user editors in the JTree.
339-
* <p/>
339+
* <p>
340340
* The default implementation does nothing (dummy method).
341341
*
342342
* @see javax.swing.tree.DefaultTreeModel#valueForPathChanged(javax.swing.tree.TreePath, java.lang.Object)

visualvm/libs.profiler/lib.profiler.ui/src/org/graalvm/visualvm/lib/ui/cpu/CPUResultsPanel.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@ public Boolean isSampling() {
117117
*
118118
* @param view one of CPUResultsSnapshot.METHOD_LEVEL_VIEW, CPUResultsSnapshot.CLASS_LEVEL_VIEW, CPUResultsSnapshot.PACKAGE_LEVEL_VIEW
119119
*
120-
* @see CPUResultsSnapshot.METHOD_LEVEL_VIEW
121-
* @see CPUResultsSnapshot.CLASS_LEVEL_VIEW
122-
* @see CPUResultsSnapshot.PACKAGE_LEVEL_VIEW
120+
* @see CPUResultsSnapshot#METHOD_LEVEL_VIEW
121+
* @see CPUResultsSnapshot#CLASS_LEVEL_VIEW
122+
* @see CPUResultsSnapshot#PACKAGE_LEVEL_VIEW
123123
*/
124124
public void changeView(int view) {
125125
if (currentView == view) {

visualvm/libs.profiler/lib.profiler.ui/src/org/graalvm/visualvm/lib/ui/cpu/FlatProfilePanel.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656

5757
/**
5858
* A common abstract superclass for Hotspots display containing a flat profile.
59-
* <p/>
59+
* <p>
6060
* The subclasses need to implement these methods:
6161
* obtainResults () to initialize the data either from snapshot or from live data.
6262
* getTitle () to provide title for the panel

0 commit comments

Comments
 (0)