Skip to content

Commit d46dcae

Browse files
kevinrushforthkevinrushforth
committed
8233338: FX javadoc headings are out of sequence
Reviewed-by: aghaisas
1 parent 94bcf3f commit d46dcae

File tree

26 files changed

+69
-69
lines changed

26 files changed

+69
-69
lines changed

‎modules/javafx.base/src/main/java/javafx/beans/binding/package.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<body>
3636
<p>Provides classes that create and operate on a {@link Binding Binding}
3737
that calculates a value that depends on one or more sources.</p>
38-
<h1>Characteristics of Bindings</h1>
38+
<h2>Characteristics of Bindings</h2>
3939
<p>Bindings are assembled from one or more sources, usually called
4040
their dependencies. A binding observes its dependencies for changes
4141
and updates its own value according to changes in the dependencies.</p>
@@ -51,7 +51,7 @@ <h1>Characteristics of Bindings</h1>
5151
That means, if a dependency changes, the result of a binding is not
5252
immediately recalculated, but it is marked as invalid. Next time the
5353
value of an invalid binding is requested, it is recalculated.</p>
54-
<h1>High Level API and Low Level API</h1>
54+
<h2>High Level API and Low Level API</h2>
5555
<p>The Binding API is roughly divided in two parts, the High Level
5656
Binding API and the Low Level Binding API. The High Level Binding API
5757
allows to construct simple bindings in an easy to use fashion.

‎modules/javafx.base/src/main/java/javafx/beans/property/package.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<p>The package {@code javafx.beans.property} defines read-only
3737
properties and writable properties, plus a number of implementations.
3838
</p>
39-
<h1>Read-only Properties</h1>
39+
<h2>Read-only Properties</h2>
4040
<p>Read-only properties have two getters, {@code get()} returns the
4141
primitive value, {@code getValue()} returns the boxed value.</p>
4242
<p>It is possible to observe read-only properties for changes. They
@@ -47,7 +47,7 @@ <h1>Read-only Properties</h1>
4747
getBean()} and {@code getName()} are defined. They return the
4848
containing bean and the name of a property.</p>
4949

50-
<h1>Writable Properties</h1>
50+
<h2>Writable Properties</h2>
5151
<p>In addition to the functionality defined for read-only
5252
properties, writable properties contain the following methods.</p>
5353
<p>A writable property defines two setters in addition to the
@@ -62,4 +62,4 @@ <h1>Writable Properties</h1>
6262
always contain the same value. If one of the properties changes, the
6363
other one will be updated.</p>
6464
</body>
65-
</html>
65+
</html>

‎modules/javafx.base/src/main/java/javafx/beans/value/package.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
fundamental interfaces {@link javafx.beans.value.ObservableValue} and {@link
3838
javafx.beans.value.WritableValue} and all of its sub-interfaces.</p>
3939

40-
<h1>ObservableValue</h1>
40+
<h2>ObservableValue</h2>
4141
An ObservableValue wraps a value that can be read and observed for
4242
invalidations and changes. Listeners have to implement either {@link
4343
javafx.beans.InvalidationListener} or {@link javafx.beans.value.ChangeListener}. To allow
@@ -83,7 +83,7 @@ <h1>ObservableValue</h1>
8383
</tr>
8484
</table>
8585

86-
<h1>WritableValue</h1>
86+
<h2>WritableValue</h2>
8787
A WritableValue wraps a value that can be read and set. As with {@code
8888
ObservableValues}, a number of sub-interfaces are defined to work with
8989
primitive types directly.

‎modules/javafx.controls/src/main/java/javafx/scene/control/ButtonBar.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
* annotations, as well as the overarching
5353
* {@link #buttonOrderProperty() button order} specified for the ButtonBar.
5454
*
55-
* <h3>Uniform button sizing</h3>
55+
* <h2>Uniform button sizing</h2>
5656
* <p>By default all buttons are uniformly sized in a ButtonBar, meaning that all
5757
* buttons take the width of the widest button. It is possible to opt-out of this
5858
* on a per-button basis, but calling the {@link #setButtonUniformSize(Node, boolean)} method with
@@ -63,7 +63,7 @@
6363
* measuring process, so its size will not influence the maximum size calculated
6464
* for all buttons in the ButtonBar.
6565
*
66-
* <h3>Screenshots</h3>
66+
* <h2>Screenshots</h2>
6767
* <p>Because a ButtonBar comes with built-in support for Windows, Mac OS
6868
* and Linux, there are three screenshots shown below, with the same buttons
6969
* laid out on each of the three operating systems.
@@ -73,7 +73,7 @@
7373
* <strong>Mac OS:</strong><p><img src="doc-files/buttonBar-mac.png" alt=""></p>
7474
* <strong>Linux:</strong><p><img src="doc-files/buttonBar-linux.png" alt=""></p>
7575
*
76-
* <h3>Code Samples</h3>
76+
* <h2>Code Samples</h2>
7777
* <p>Instantiating and using the ButtonBar is simple, simply do the following:
7878
*
7979
* <pre>

‎modules/javafx.controls/src/main/java/javafx/scene/control/Cell.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187
* }
188188
* </pre>
189189
*
190-
* <h3>Key Design Goals</h3>
190+
* <h2>Key Design Goals</h2>
191191
* <ul>
192192
* <li>Both time and memory efficient for large data sets</li>
193193
* <li>Easy to build and use libraries for custom cells</li>
@@ -198,7 +198,7 @@
198198
* <li>Easy to animate the cell size or other properties</li>
199199
* </ul>
200200
*
201-
* <h3>Key Use Cases</h3>
201+
* <h2>Key Use Cases</h2>
202202
* Following are a number of key use cases used to drive the Cell API design,
203203
* along with code examples showing how those use cases are satisfied by this
204204
* API. This is by no means to be considered the definitive list of capabilities
@@ -262,7 +262,7 @@
262262
* -fx-text-fill: red;
263263
* }</pre>
264264
*
265-
* <h3>Editing</h3>
265+
* <h2>Editing</h2>
266266
* <p>Most virtualized controls that use the Cell architecture (e.g. {@link ListView},
267267
* {@link TreeView}, {@link TableView} and {@link TreeTableView}) all support
268268
* the notion of editing values directly via the cell. You can learn more about

‎modules/javafx.controls/src/main/java/javafx/scene/control/ComboBox.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@
123123
* a different type is specified and the ComboBox is to be editable, it is
124124
* necessary to specify a custom {@link StringConverter}.
125125
*
126-
* <h3>A warning about inserting Nodes into the ComboBox items list</h3>
126+
* <h2>A warning about inserting Nodes into the ComboBox items list</h2>
127127
* ComboBox allows for the items list to contain elements of any type, including
128128
* {@link Node} instances. Putting nodes into
129129
* the items list is <strong>strongly not recommended</strong>. This is because

‎modules/javafx.controls/src/main/java/javafx/scene/control/Dialog.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@
152152
* the above is to help introduce developers to the {@link Optional} API, which
153153
* is new in Java 8 and may be foreign to many developers.
154154
*
155-
* <h3>Dialog Validation / Intercepting Button Actions</h3>
155+
* <h2>Dialog Validation / Intercepting Button Actions</h2>
156156
*
157157
* <p>In some circumstances it is desirable to prevent a dialog from closing
158158
* until some aspect of the dialog becomes internally consistent (e.g. a form
@@ -175,7 +175,7 @@
175175
* }
176176
* });}</pre>
177177
*
178-
* <h3>Dialog Closing Rules</h3>
178+
* <h2>Dialog Closing Rules</h2>
179179
*
180180
* <p>It is important to understand what happens when a Dialog is closed, and
181181
* also how a Dialog can be closed, especially in abnormal closing situations

‎modules/javafx.controls/src/main/java/javafx/scene/control/ListView.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
* making use of ListView, as all modern IDEs are able to auto-complete far
8989
* more successfully with the additional type information.
9090
*
91-
* <h3>Populating a ListView</h3>
91+
* <h2>Populating a ListView</h2>
9292
* <p>A simple example of how to create and populate a ListView of names (Strings)
9393
* is shown here:
9494
*
@@ -122,7 +122,7 @@
122122
* copied into the items list - meaning that subsequent changes to the content
123123
* list are not observed, and will not be reflected visually within the ListView.
124124
*
125-
* <h3>ListView Selection / Focus APIs</h3>
125+
* <h2>ListView Selection / Focus APIs</h2>
126126
* <p>To track selection and focus, it is necessary to become familiar with the
127127
* {@link SelectionModel} and {@link FocusModel} classes. A ListView has at most
128128
* one instance of each of these classes, available from
@@ -142,14 +142,14 @@
142142
*
143143
* <pre> {@code listView.getSelectionModel().setSelectionMode(SelectionMode.MULTIPLE);}</pre>
144144
*
145-
* <h3>Customizing ListView Visuals</h3>
145+
* <h2>Customizing ListView Visuals</h2>
146146
* <p>The visuals of the ListView can be entirely customized by replacing the
147147
* default {@link #cellFactoryProperty() cell factory}. A cell factory is used to
148148
* generate {@link ListCell} instances, which are used to represent an item in the
149149
* ListView. See the {@link Cell} class documentation for a more complete
150150
* description of how to write custom Cells.
151151
*
152-
* <h3>Editing</h3>
152+
* <h2>Editing</h2>
153153
* <p>This control supports inline editing of values, and this section attempts to
154154
* give an overview of the available APIs and how you should use them.</p>
155155
*

‎modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
* which has been divided into smaller parts.
5252
* </p>
5353
*
54-
* <h3>Styling the page indicators</h3>
54+
* <h2>Styling the page indicators</h2>
5555
* <p>
5656
* The control can be customized to display numeric page indicators or bullet style indicators by
5757
* setting the style class {@link #STYLE_CLASS_BULLET}. The
@@ -60,14 +60,14 @@
6060
* via CSS using -fx-max-page-indicator-count.
6161
*</p>
6262
*
63-
* <h3>Page count</h3>
63+
* <h2>Page count</h2>
6464
* <p>
6565
* The {@link #pageCountProperty() pageCountProperty} controls the number of
6666
* pages this pagination control has. If the page count is
6767
* not known {@link #INDETERMINATE} should be used as the page count.
6868
* </p>
6969
*
70-
* <h3>Page factory</h3>
70+
* <h2>Page factory</h2>
7171
* <p>
7272
* The {@link #pageFactoryProperty() pageFactoryProperty} is a callback function
7373
* that is called when a page has been selected by the application or
@@ -76,7 +76,7 @@
7676
* Null should be returned if the selected page index does not exist.
7777
* </p>
7878
*
79-
* <h3>Creating a Pagination control:</h3>
79+
* <h2>Creating a Pagination control:</h2>
8080
* <p>
8181
* A simple example of how to create a pagination control with ten pages and
8282
* each page containing text.

‎modules/javafx.controls/src/main/java/javafx/scene/control/TreeView.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
* nodes of the root node are shown. By default, the root node is shown in the
100100
* TreeView.
101101
*
102-
* <h3>TreeView Selection / Focus APIs</h3>
102+
* <h2>TreeView Selection / Focus APIs</h2>
103103
* <p>To track selection and focus, it is necessary to become familiar with the
104104
* {@link SelectionModel} and {@link FocusModel} classes. A TreeView has at most
105105
* one instance of each of these classes, available from
@@ -119,14 +119,14 @@
119119
*
120120
* <pre> {@code treeView.getSelectionModel().setSelectionMode(SelectionMode.MULTIPLE);}</pre>
121121
*
122-
* <h3>Customizing TreeView Visuals</h3>
122+
* <h2>Customizing TreeView Visuals</h2>
123123
* <p>The visuals of the TreeView can be entirely customized by replacing the
124124
* default {@link #cellFactoryProperty() cell factory}. A cell factory is used to
125125
* generate {@link TreeCell} instances, which are used to represent an item in the
126126
* TreeView. See the {@link Cell} class documentation for a more complete
127127
* description of how to write custom Cells.
128128
*
129-
* <h3>Editing</h3>
129+
* <h2>Editing</h2>
130130
* <p>This control supports inline editing of values, and this section attempts to
131131
* give an overview of the available APIs and how you should use them.</p>
132132
*

‎modules/javafx.graphics/src/main/java/javafx/scene/Node.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@
225225
* an UnsupportedOperationException being thrown.
226226
* </p>
227227
*
228-
* <h3>String ID</h3>
228+
* <h2>String ID</h2>
229229
* <p>
230230
* Each node in the scene graph can be given a unique {@link #idProperty id}. This id is
231231
* much like the "id" attribute of an HTML tag in that it is up to the designer
@@ -235,7 +235,7 @@
235235
* scene graph. The id can also be used identify nodes for applying styles; see
236236
* the CSS section below.
237237
*
238-
* <h3>Coordinate System</h3>
238+
* <h2>Coordinate System</h2>
239239
* <p>
240240
* The {@code Node} class defines a traditional computer graphics "local"
241241
* coordinate system in which the {@code x} axis increases to the right and the
@@ -268,7 +268,7 @@
268268
* important context-specific information about coordinate mapping and how
269269
* it can affect rendering.
270270
*
271-
* <h3>Transformations</h3>
271+
* <h2>Transformations</h2>
272272
* <p>
273273
* Any {@code Node} can have transformations applied to it. These include
274274
* translation, rotation, scaling, or shearing.
@@ -325,7 +325,7 @@
325325
* chain of transforms. The order in which the transforms are applied is
326326
* defined by the ObservableList specified in the {@link #getTransforms transforms} variable.
327327
*
328-
* <h3>Bounding Rectangles</h3>
328+
* <h2>Bounding Rectangles</h2>
329329
* <p>
330330
* Since every {@code Node} has transformations, every Node's geometric
331331
* bounding rectangle can be described differently depending on whether
@@ -381,7 +381,7 @@
381381
* respective bounds"> </p>
382382
*
383383
*
384-
* <h3>CSS</h3>
384+
* <h2>CSS</h2>
385385
* <p>
386386
* The {@code Node} class contains {@code id}, {@code styleClass}, and
387387
* {@code style} variables that are used in styling this node from

‎modules/javafx.graphics/src/main/java/javafx/scene/input/DragEvent.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
* Drag entered/exited events behave similarly to mouse entered/exited
5252
* events, please see {@code MouseEvent} overview.
5353
*
54-
* <h3>Drag sources: initiating a drag and drop gesture</h3>
54+
* <h2>Drag sources: initiating a drag and drop gesture</h2>
5555
*
5656
* When a drag gesture is detected, an application can decide whether to
5757
* start a drag and drop gesture or continue with a press-drag-release gesture.
@@ -95,7 +95,7 @@
9595
});
9696
* </pre>
9797
*
98-
* <br><h3>Potential drop targets</h3>
98+
* <br><h2>Potential drop targets</h2>
9999
*
100100
* <p>
101101
* After the drag and drop gesture has been started, any object
@@ -183,7 +183,7 @@
183183
});
184184
* </pre>
185185
*
186-
* <h3>Drag sources: finalizing drag and drop gesture</h3>
186+
* <h2>Drag sources: finalizing drag and drop gesture</h2>
187187
*
188188
* <p>
189189
* After the gesture has been finished, whether by successful or unsuccessful

‎modules/javafx.graphics/src/main/java/javafx/scene/input/MouseEvent.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
* screenX,screenY - relative to origin of the screen that
5050
* contains the mouse pointer.
5151
*
52-
* <h3>Dragging gestures</h3>
52+
* <h2>Dragging gestures</h2>
5353
* <p>
5454
* There are three types of dragging gestures. They are all initiated by
5555
* a mouse press event and terminated as a result of a mouse released
@@ -94,7 +94,7 @@
9494
* {@code isSynthesized()} method may be used to detect the problem and make the
9595
* dragging handlers behave accordingly.
9696
*
97-
* <h3>Mouse enter/exit handling</h3>
97+
* <h2>Mouse enter/exit handling</h2>
9898
* <p>
9999
* When mouse enters a node, the node gets {@code MOUSE_ENTERED} event, when
100100
* it leaves, it gets {@code MOUSE_EXITED} event. These events are delivered
@@ -122,7 +122,7 @@
122122
* {@code MOUSE_ENTERED_TARGET} event handler will receive the
123123
* {@code MOUSE_ENTERED} event on target.
124124
*
125-
* <h3>Notes</h3>
125+
* <h2>Notes</h2>
126126
* <ul>
127127
* <li>For triggering context menus see the {@link ContextMenuEvent}.</li>
128128
* </ul>

‎modules/javafx.graphics/src/main/java/javafx/scene/layout/AnchorPane.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
* AnchorPanes may be styled with backgrounds and borders using CSS. See
4343
* {@link javafx.scene.layout.Region Region} superclass for details.</p>
4444
*
45-
* <h3>Anchor Constraints</h3>
45+
* <h2>Anchor Constraints</h2>
4646
* <p>
4747
* The application sets anchor constraints on each child to configure the anchors
4848
* on one or more sides. If a child is anchored on opposite sides (and is resizable), the
@@ -75,7 +75,7 @@
7575
* anchorPane.getChildren().addAll(list, button);
7676
* </code></pre>
7777
*
78-
* <h3>Resizable Range</h3>
78+
* <h2>Resizable Range</h2>
7979
* <p>
8080
* An anchor pane's parent will resize the anchor pane within the anchor pane's resizable range
8181
* during layout. By default the anchor pane computes this range based on its content

‎modules/javafx.graphics/src/main/java/javafx/scene/layout/BorderPane.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
* BorderPane lays out each child set in the five positions regardless of the child's
8383
* visible property value; unmanaged children are ignored.</p>
8484
*
85-
* <h3>Resizable Range</h3>
85+
* <h2>Resizable Range</h2>
8686
* <p>
8787
* BorderPane is commonly used as the root of a {@link javafx.scene.Scene Scene},
8888
* in which case its size will track the size of the scene. If the scene or stage
@@ -122,7 +122,7 @@
122122
* bounds may extend outside its own bounds if a child's min size prevents it from
123123
* being fit within it space.</p>
124124
*
125-
* <h4>Optional Layout Constraints</h4>
125+
* <h2>Optional Layout Constraints</h2>
126126
*
127127
* <p>
128128
* An application may set constraints on individual children to customize BorderPane's layout.

‎modules/javafx.graphics/src/main/java/javafx/scene/layout/FlowPane.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
* FlowPane may be styled with backgrounds and borders using CSS. See
9999
* {@link javafx.scene.layout.Region Region} superclass for details.</p>
100100
*
101-
* <h3>Resizable Range</h3>
101+
* <h2>Resizable Range</h2>
102102
*
103103
* <p>
104104
* A flowpane's parent will resize the flowpane within the flowpane's resizable range

0 commit comments

Comments
 (0)