From a44bfb183e0feaa5831bc6c30a9cfe0b5e6df40c Mon Sep 17 00:00:00 2001 From: nlisker <37422899+nlisker@users.noreply.github.com> Date: Tue, 28 Jul 2020 21:16:26 +0300 Subject: [PATCH] Corrected javadoc generation errors --- .../java/javafx/scene/control/Labeled.java | 33 +++++++++---------- .../java/javafx/scene/control/Pagination.java | 2 +- .../main/java/javafx/animation/Timeline.java | 4 +-- 3 files changed, 19 insertions(+), 20 deletions(-) diff --git a/modules/javafx.controls/src/main/java/javafx/scene/control/Labeled.java b/modules/javafx.controls/src/main/java/javafx/scene/control/Labeled.java index 6aead30faeb..6679f5c500f 100644 --- a/modules/javafx.controls/src/main/java/javafx/scene/control/Labeled.java +++ b/modules/javafx.controls/src/main/java/javafx/scene/control/Labeled.java @@ -25,7 +25,6 @@ package javafx.scene.control; - import com.sun.javafx.css.StyleManager; import com.sun.javafx.scene.NodeHelper; import javafx.css.converter.BooleanConverter; @@ -68,7 +67,6 @@ import javafx.css.StyleableProperty; import javafx.css.StyleableStringProperty; - /** * A Labeled {@link Control} is one which has as part of its user interface * a textual content associated with it. For example, a {@link Button} displays @@ -137,7 +135,7 @@ public Labeled(String text, Node graphic) { * The text to display in the label. The text may be null. * * @return the text to display in the label - * @default {@code ""} (empty string} + * @defaultValue {@code ""} (empty string} */ public final StringProperty textProperty() { if (text == null) { @@ -152,7 +150,9 @@ public final StringProperty textProperty() { /** * Specifies how the text and graphic within the Labeled should be * aligned when there is empty space within the Labeled. + * * @return the alignment within this labeled + * @defaultValue {@code Pos.CENTER_LEFT} */ public final ObjectProperty alignmentProperty() { if (alignment == null) { @@ -186,7 +186,7 @@ public String getName() { * only affects multiple lines of text relative to the text bounds. * * @return the alignment of lines of text within this labeled - * @default {@code TextAlignment.LEFT} + * @defaultValue {@code TextAlignment.LEFT} */ public final ObjectProperty textAlignmentProperty() { if (textAlignment == null) { @@ -219,7 +219,7 @@ public String getName() { * exceeds the available space for rendering the text. * * @return the overrun behavior if the text exceeds the available space - * @default {@code OverrunStyle.ELLIPSIS} + * @defaultValue {@code OverrunStyle.ELLIPSIS} */ public final ObjectProperty textOverrunProperty() { if (textOverrun == null) { @@ -266,7 +266,7 @@ public String getName() { * when text is truncated * @see Wikipedia:ellipsis * @since JavaFX 2.2 - * @default {@code "..."} + * @defaultValue {@code "..."} */ public final StringProperty ellipsisStringProperty() { if (ellipsisString == null) { @@ -296,7 +296,7 @@ public final StringProperty ellipsisStringProperty() { * indicates whether the text should wrap onto another line. * * @return the wrap property if a run of text exceeds the width of the Labeled - * @default {@code false} + * @defaultValue {@code false} */ public final BooleanProperty wrapTextProperty() { if (wrapText == null) { @@ -339,7 +339,7 @@ public String getName() { * font is required, this font will be used. * * @return the default font to use for text in this labeled - * @default {@link Font#getDefault()} + * @defaultValue {@link Font#getDefault()} */ public final ObjectProperty fontProperty() { @@ -417,7 +417,7 @@ public String getName() { * description of {@link Node} for more detail. * * @return the optional icon for this labeled - * @default {@code null} + * @defaultValue {@code null} */ public final ObjectProperty graphicProperty() { if (graphic == null) { @@ -577,7 +577,7 @@ public CssMetaData getCssMetaData() { * Whether all text should be underlined. * * @return the underline property of all text in this labeled - * @default {@code false} + * @defaultValue {@code false} */ public final BooleanProperty underlineProperty() { if (underline == null) { @@ -610,7 +610,7 @@ public String getName() { * * @return the line spacing property between lines in this labeled * @since JavaFX 8.0 - * @default 0 + * @defaultValue 0 */ public final DoubleProperty lineSpacingProperty() { if (lineSpacing == null) { @@ -642,7 +642,7 @@ public String getName() { * Specifies the positioning of the graphic relative to the text. * * @return content display property of this labeled - * @default {@code ContentDisplay.LEFT} + * @defaultValue {@code ContentDisplay.LEFT} */ public final ObjectProperty contentDisplayProperty() { if (contentDisplay == null) { @@ -678,7 +678,7 @@ public String getName() { * This property can only be set from CSS. * * @return the label padding property of this labeled - * @default {@code Insets.EMPTY} + * @defaultValue {@code Insets.EMPTY} */ public final ReadOnlyObjectProperty labelPaddingProperty() { return labelPaddingPropertyImpl(); @@ -725,7 +725,7 @@ public String getName() { * The amount of space between the graphic and text * * @return the graphics text gap property of this labeled - * @default 4 + * @defaultValue 4 */ public final DoubleProperty graphicTextGapProperty() { if (graphicTextGap == null) { @@ -757,7 +757,7 @@ public String getName() { /** * The {@link Paint} used to fill the text. * - * @default {@code Color.BLACK} + * @defaultValue {@code Color.BLACK} */ private ObjectProperty textFill; // TODO for now change this @@ -801,8 +801,7 @@ public String getName() { * be determined based on the succeeding character, and the mnemonic * added. * - * @default {@code false}; {@code true} for some Controls. - *

+ * @defaultValue {@code false}; {@code true} for some Controls. */ private BooleanProperty mnemonicParsing; public final void setMnemonicParsing(boolean value) { diff --git a/modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java b/modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java index 00d4e80fa74..d449ac9f32a 100644 --- a/modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java +++ b/modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java @@ -95,7 +95,7 @@ * }); * or using lambdas * 
 Pagination pagination = new Pagination(10, 0);
- * pagination.setPageFactory(pageIndex ->
+ * pagination.setPageFactory(pageIndex ->
  *         new Label(pageIndex + 1 + ". Lorem ipsum dolor sit amet,\n"
  *                      + "consectetur adipiscing elit,\n"
  *                      + "sed do eiusmod tempor incididunt ut\n"
diff --git a/modules/javafx.graphics/src/main/java/javafx/animation/Timeline.java b/modules/javafx.graphics/src/main/java/javafx/animation/Timeline.java
index c23cb766461..f2c583ab91a 100644
--- a/modules/javafx.graphics/src/main/java/javafx/animation/Timeline.java
+++ b/modules/javafx.graphics/src/main/java/javafx/animation/Timeline.java
@@ -116,7 +116,7 @@ protected void onChanged(Change c) {
     };
 
     /**
-     * Creates a {@code Timeline} with the provided key frames and a {@link Animation#targetFramerate() target framerate}.
+     * Creates a {@code Timeline} with the provided key frames and a {@link Animation#getTargetFramerate() target framerate}.
      * The key frames do not need to be ordered.
      *
      * @param targetFramerate
@@ -143,7 +143,7 @@ public Timeline(KeyFrame... keyFrames) {
     }
 
     /**
-     * Creates a {@code Timeline} with no key frames and a {@link Animation#targetFramerate() target framerate}.
+     * Creates a {@code Timeline} with no key frames and a {@link Animation#getTargetFramerate() target framerate}.
      *
      * @param targetFramerate
      *            the custom target frame rate for this {@code Timeline}