Skip to content

Commit a1ef818

Browse files
committed
8342825: Fix order of @param tags in module java.desktop
Reviewed-by: prr
1 parent cdad728 commit a1ef818

File tree

12 files changed

+48
-48
lines changed

12 files changed

+48
-48
lines changed

src/java.desktop/share/classes/java/awt/BorderLayout.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1995, 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1995, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -554,12 +554,12 @@ public Component getLayoutComponent(Object constraints) {
554554
* The {@code Container}'s component orientation is used to determine the location of components
555555
* added with {@code LINE_START} and {@code LINE_END}.
556556
*
557-
* @param constraints the desired absolute position, one of {@code CENTER},
558-
* {@code NORTH}, {@code SOUTH},
559-
* {@code EAST}, {@code WEST}
560557
* @param target the {@code Container} used to obtain
561558
* the constraint location based on the target
562559
* {@code Container}'s component orientation.
560+
* @param constraints the desired absolute position, one of {@code CENTER},
561+
* {@code NORTH}, {@code SOUTH},
562+
* {@code EAST}, {@code WEST}
563563
* @return the component at the given location, or {@code null} if
564564
* the location is empty
565565
* @throws IllegalArgumentException if the constraint object is

src/java.desktop/share/classes/java/awt/Graphics2D.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1996, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -564,9 +564,9 @@ public abstract boolean drawImage(Image img,
564564
* img1 = op.filter(img, null);
565565
* drawImage(img1, new AffineTransform(1f,0f,0f,1f,x,y), null);
566566
* </pre>
567-
* @param op the filter to be applied to the image before rendering
568567
* @param img the specified {@code BufferedImage} to be rendered.
569568
* This method does nothing if {@code img} is null.
569+
* @param op the filter to be applied to the image before rendering
570570
* @param x the x coordinate of the location in user space where
571571
* the upper left corner of the image is rendered
572572
* @param y the y coordinate of the location in user space where

src/java.desktop/share/classes/java/awt/dnd/DragSource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -499,8 +499,8 @@ protected DragSourceContext createDragSourceContext(DragGestureEvent dgl,
499499
*
500500
* @param <T> the type of {@code DragGestureRecognizer} to create
501501
* @param recognizerAbstractClass the requested abstract type
502-
* @param actions the permitted source drag actions
503502
* @param c the {@code Component} target
503+
* @param actions the permitted source drag actions
504504
* @param dgl the {@code DragGestureListener} to notify
505505
*
506506
* @return the new {@code DragGestureRecognizer} or {@code null}

src/java.desktop/share/classes/java/awt/event/ActionEvent.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1996, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -206,13 +206,13 @@ public ActionEvent(Object source, int id, String command, int modifiers) {
206206
* the class description for {@link ActionEvent}
207207
* @param command A string that may specify a command (possibly one
208208
* of several) associated with the event
209+
* @param when A long that gives the time the event occurred.
210+
* Passing negative or zero value
211+
* is not recommended
209212
* @param modifiers The modifier keys down during event
210213
* (shift, ctrl, alt, meta).
211214
* Passing negative parameter is not recommended.
212215
* Zero value means that no modifiers were passed
213-
* @param when A long that gives the time the event occurred.
214-
* Passing negative or zero value
215-
* is not recommended
216216
* @throws IllegalArgumentException if {@code source} is null
217217
* @see #getSource()
218218
* @see #getID()

src/java.desktop/share/classes/java/awt/geom/AffineTransform.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1996, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -2964,10 +2964,10 @@ public Point2D transform(Point2D ptSrc, Point2D ptDst) {
29642964
* the original coordinates in that point are overwritten before
29652965
* they can be converted.
29662966
* @param ptSrc the array containing the source point objects
2967-
* @param ptDst the array into which the transform point objects are
2968-
* returned
29692967
* @param srcOff the offset to the first point object to be
29702968
* transformed in the source array
2969+
* @param ptDst the array into which the transform point objects are
2970+
* returned
29712971
* @param dstOff the offset to the location of the first
29722972
* transformed point object that is stored in the destination array
29732973
* @param numPts the number of point objects to be transformed
@@ -3038,11 +3038,11 @@ public void transform(Point2D[] ptSrc, int srcOff,
30383038
* offset in the order {@code [x0, y0, x1, y1, ..., xn, yn]}.
30393039
* @param srcPts the array containing the source point coordinates.
30403040
* Each point is stored as a pair of x,&nbsp;y coordinates.
3041+
* @param srcOff the offset to the first point to be transformed
3042+
* in the source array
30413043
* @param dstPts the array into which the transformed point coordinates
30423044
* are returned. Each point is stored as a pair of x,&nbsp;y
30433045
* coordinates.
3044-
* @param srcOff the offset to the first point to be transformed
3045-
* in the source array
30463046
* @param dstOff the offset to the location of the first
30473047
* transformed point that is stored in the destination array
30483048
* @param numPts the number of points to be transformed
@@ -3153,11 +3153,11 @@ public void transform(float[] srcPts, int srcOff,
31533153
* offset in the order {@code [x0, y0, x1, y1, ..., xn, yn]}.
31543154
* @param srcPts the array containing the source point coordinates.
31553155
* Each point is stored as a pair of x,&nbsp;y coordinates.
3156+
* @param srcOff the offset to the first point to be transformed
3157+
* in the source array
31563158
* @param dstPts the array into which the transformed point
31573159
* coordinates are returned. Each point is stored as a pair of
31583160
* x,&nbsp;y coordinates.
3159-
* @param srcOff the offset to the first point to be transformed
3160-
* in the source array
31613161
* @param dstOff the offset to the location of the first
31623162
* transformed point that is stored in the destination array
31633163
* @param numPts the number of point objects to be transformed
@@ -3264,11 +3264,11 @@ public void transform(double[] srcPts, int srcOff,
32643264
* offset in the order {@code [x0, y0, x1, y1, ..., xn, yn]}.
32653265
* @param srcPts the array containing the source point coordinates.
32663266
* Each point is stored as a pair of x,&nbsp;y coordinates.
3267+
* @param srcOff the offset to the first point to be transformed
3268+
* in the source array
32673269
* @param dstPts the array into which the transformed point coordinates
32683270
* are returned. Each point is stored as a pair of x,&nbsp;y
32693271
* coordinates.
3270-
* @param srcOff the offset to the first point to be transformed
3271-
* in the source array
32723272
* @param dstOff the offset to the location of the first
32733273
* transformed point that is stored in the destination array
32743274
* @param numPts the number of points to be transformed
@@ -3360,11 +3360,11 @@ public void transform(float[] srcPts, int srcOff,
33603360
* offset in the order {@code [x0, y0, x1, y1, ..., xn, yn]}.
33613361
* @param srcPts the array containing the source point coordinates.
33623362
* Each point is stored as a pair of x,&nbsp;y coordinates.
3363+
* @param srcOff the offset to the first point to be transformed
3364+
* in the source array
33633365
* @param dstPts the array into which the transformed point
33643366
* coordinates are returned. Each point is stored as a pair of
33653367
* x,&nbsp;y coordinates.
3366-
* @param srcOff the offset to the first point to be transformed
3367-
* in the source array
33683368
* @param dstOff the offset to the location of the first
33693369
* transformed point that is stored in the destination array
33703370
* @param numPts the number of point objects to be transformed
@@ -3542,11 +3542,11 @@ public Point2D inverseTransform(Point2D ptSrc, Point2D ptDst)
35423542
* offset in the order {@code [x0, y0, x1, y1, ..., xn, yn]}.
35433543
* @param srcPts the array containing the source point coordinates.
35443544
* Each point is stored as a pair of x,&nbsp;y coordinates.
3545+
* @param srcOff the offset to the first point to be transformed
3546+
* in the source array
35453547
* @param dstPts the array into which the transformed point
35463548
* coordinates are returned. Each point is stored as a pair of
35473549
* x,&nbsp;y coordinates.
3548-
* @param srcOff the offset to the first point to be transformed
3549-
* in the source array
35503550
* @param dstOff the offset to the location of the first
35513551
* transformed point that is stored in the destination array
35523552
* @param numPts the number of point objects to be transformed
@@ -3755,11 +3755,11 @@ public Point2D deltaTransform(Point2D ptSrc, Point2D ptDst) {
37553755
* offset in the order {@code [x0, y0, x1, y1, ..., xn, yn]}.
37563756
* @param srcPts the array containing the source distance vectors.
37573757
* Each vector is stored as a pair of relative x,&nbsp;y coordinates.
3758+
* @param srcOff the offset to the first vector to be transformed
3759+
* in the source array
37583760
* @param dstPts the array into which the transformed distance vectors
37593761
* are returned. Each vector is stored as a pair of relative
37603762
* x,&nbsp;y coordinates.
3761-
* @param srcOff the offset to the first vector to be transformed
3762-
* in the source array
37633763
* @param dstOff the offset to the location of the first
37643764
* transformed vector that is stored in the destination array
37653765
* @param numPts the number of vector coordinate pairs to be

src/java.desktop/share/classes/javax/imageio/metadata/IIOMetadataFormatImpl.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2000, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -378,10 +378,10 @@ protected void addElement(String elementName,
378378
* Adds an existing element to the list of legal children for a
379379
* given parent node type.
380380
*
381-
* @param parentName the name of the element that will be the
382-
* new parent of the element.
383381
* @param elementName the name of the element to be added as a
384382
* child.
383+
* @param parentName the name of the element that will be the
384+
* new parent of the element.
385385
*
386386
* @throws IllegalArgumentException if {@code elementName}
387387
* is {@code null}, or is not a legal element name for this

src/java.desktop/share/classes/javax/swing/GroupLayout.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2006, 2023, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2006, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -1777,9 +1777,9 @@ public SequentialGroup addGroup(Group group) {
17771777
/**
17781778
* Adds a {@code Group} to this {@code Group}.
17791779
*
1780-
* @param group the {@code Group} to add
17811780
* @param useAsBaseline whether the specified {@code Group} should
17821781
* be used to calculate the baseline for this {@code Group}
1782+
* @param group the {@code Group} to add
17831783
* @return this {@code Group}
17841784
*/
17851785
public SequentialGroup addGroup(boolean useAsBaseline, Group group) {
@@ -2528,8 +2528,8 @@ public ParallelGroup addGroup(Alignment alignment, Group group) {
25282528
* Adds a {@code Component} to this {@code ParallelGroup} with
25292529
* the specified alignment.
25302530
*
2531-
* @param alignment the alignment
25322531
* @param component the {@code Component} to add
2532+
* @param alignment the alignment
25332533
* @return this {@code Group}
25342534
* @throws IllegalArgumentException if {@code alignment} is
25352535
* {@code null}
@@ -2544,8 +2544,8 @@ public ParallelGroup addComponent(Component component,
25442544
* Adds a {@code Component} to this {@code ParallelGroup} with the
25452545
* specified alignment and size.
25462546
*
2547-
* @param alignment the alignment
25482547
* @param component the {@code Component} to add
2548+
* @param alignment the alignment
25492549
* @param min the minimum size
25502550
* @param pref the preferred size
25512551
* @param max the maximum size

src/java.desktop/share/classes/javax/swing/LayoutStyle.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2005, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -165,13 +165,13 @@ public LayoutStyle() {
165165
* @param component1 the <code>JComponent</code>
166166
* <code>component2</code> is being placed relative to
167167
* @param component2 the <code>JComponent</code> being placed
168+
* @param type how the two components are being placed
168169
* @param position the position <code>component2</code> is being placed
169170
* relative to <code>component1</code>; one of
170171
* <code>SwingConstants.NORTH</code>,
171172
* <code>SwingConstants.SOUTH</code>,
172173
* <code>SwingConstants.EAST</code> or
173174
* <code>SwingConstants.WEST</code>
174-
* @param type how the two components are being placed
175175
* @param parent the parent of <code>component2</code>; this may differ
176176
* from the actual parent and it may be <code>null</code>
177177
* @return the amount of space to place between the two components

src/java.desktop/share/classes/javax/swing/ProgressMonitorInputStream.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1997, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -73,10 +73,10 @@ public class ProgressMonitorInputStream extends FilterInputStream
7373
/**
7474
* Constructs an object to monitor the progress of an input stream.
7575
*
76-
* @param message Descriptive text to be placed in the dialog box
77-
* if one is popped up.
7876
* @param parentComponent The component triggering the operation
7977
* being monitored.
78+
* @param message Descriptive text to be placed in the dialog box
79+
* if one is popped up.
8080
* @param in The input stream to be monitored.
8181
*/
8282
public ProgressMonitorInputStream(Component parentComponent,

src/java.desktop/share/classes/javax/swing/text/PlainView.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1997, 2024, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -724,12 +724,12 @@ protected void updateDamage(DocumentEvent changes, Shape a, ViewFactory f) {
724724
/**
725725
* Repaint the given line range.
726726
*
727-
* @param host the component hosting the view (used to call repaint)
728-
* @param a the region allocated for the view to render into
729727
* @param line0 the starting line number to repaint. This must
730728
* be a valid line number in the model.
731729
* @param line1 the ending line number to repaint. This must
732730
* be a valid line number in the model.
731+
* @param a the region allocated for the view to render into
732+
* @param host the component hosting the view (used to call repaint)
733733
* @since 1.4
734734
*/
735735
protected void damageLineRange(int line0, int line1, Shape a, Component host) {

0 commit comments

Comments
 (0)