Skip to content

Commit

Permalink
Reduce Javadoc warnings.
Browse files Browse the repository at this point in the history
  • Loading branch information
@TomasMikula
TomasMikula committed Jun 9, 2014
1 parent 6cd3013 commit 8f4a637
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 29 deletions.
5 changes: 5 additions & 0 deletions richtextfx/build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ dependencies {
testCompile group: 'junit', name: 'junit', version: '[4.0,)'
}

javadoc {
// ignore missing Javadoc comments or tags
options.addStringOption('Xdoclint:all,-missing', '-quiet')
}

task javadocJar(type: Jar, dependsOn: javadoc) {
classifier = 'javadoc'
from 'build/docs/javadoc'
Expand Down
20 changes: 10 additions & 10 deletions richtextfx/src/main/java/org/fxmisc/richtext/EditableStyledDocument.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@
final class EditableStyledDocument<S>
extends StyledDocumentBase<S, ObservableList<Paragraph<S>>> {

/**************************************************************************
/* ********************************************************************** *
* *
* Observables *
* *
* Observables are "dynamic" (i.e. changing) characteristics of an object.*
* They are not directly settable by the client code, but change in *
* response to user input and/or API actions. *
* *
**************************************************************************/
* ********************************************************************** */

/**
* Content of this {@code StyledDocument}.
Expand Down Expand Up @@ -76,11 +76,11 @@ public ReadOnlyStyledDocument<S> snapshot() {
}


/**************************************************************************
/* ********************************************************************** *
* *
* Event streams *
* *
**************************************************************************/
* ********************************************************************** */

// To publish a text change:
// 1. push to textChangePosition,
Expand Down Expand Up @@ -139,11 +139,11 @@ public ReadOnlyStyledDocument<S> snapshot() {
}


/**************************************************************************
/* ********************************************************************** *
* *
* Constructors *
* *
**************************************************************************/
* ********************************************************************** */

@SuppressWarnings("unchecked")
EditableStyledDocument(S initialStyle) {
Expand All @@ -152,14 +152,14 @@ public ReadOnlyStyledDocument<S> snapshot() {
}


/**************************************************************************
/* ********************************************************************** *
* *
* Actions *
* *
* Actions change the state of the object. They typically cause a change *
* of one or more observables and/or produce an event. *
* *
**************************************************************************/
* ********************************************************************** */

public void replaceText(int start, int end, String replacement) {
ensureValidRange(start, end);
Expand Down Expand Up @@ -315,11 +315,11 @@ public void setStyleSpans(int paragraph, int from, StyleSpans<? extends S> style
}


/**************************************************************************
/* ********************************************************************** *
* *
* Private methods *
* *
**************************************************************************/
* ********************************************************************** */

/**
* Filters out illegal characters.
Expand Down
36 changes: 18 additions & 18 deletions richtextfx/src/main/java/org/fxmisc/richtext/StyledTextArea.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public class StyledTextArea<S> extends Control
private static final IndexRange EMPTY_RANGE = new IndexRange(0, 0);


/**************************************************************************
/* ********************************************************************** *
* *
* Properties *
* *
Expand All @@ -88,7 +88,7 @@ public class StyledTextArea<S> extends Control
* other means, i.e. they contain either the default value or the value *
* set by the client code. *
* *
**************************************************************************/
* ********************************************************************** */

// editable property
private final BooleanProperty editable = new EditableProperty<>(this);
Expand Down Expand Up @@ -164,15 +164,15 @@ public void setUndoManager(UndoManagerFactory undoManagerFactory) {
public ObjectProperty<Duration> mouseOverTextDelayProperty() { return mouseOverTextDelay; }


/**************************************************************************
/* ********************************************************************** *
* *
* Observables *
* *
* Observables are "dynamic" (i.e. changing) characteristics of this *
* control. They are not directly settable by the client code, but change *
* in response to user input and/or API actions. *
* *
**************************************************************************/
* ********************************************************************** */

// text
private final org.reactfx.inhibeans.binding.Binding<String> text;
Expand Down Expand Up @@ -234,11 +234,11 @@ public void setUndoManager(UndoManagerFactory undoManagerFactory) {
public boolean isBeingUpdated() { return beingUpdated.isOn(); }


/**************************************************************************
/* ********************************************************************** *
* *
* Event streams *
* *
**************************************************************************/
* ********************************************************************** */

// text changes
private final InterceptableEventStream<PlainTextChange> plainTextChanges;
Expand All @@ -251,11 +251,11 @@ public void setUndoManager(UndoManagerFactory undoManagerFactory) {
public final EventStream<RichTextChange<S>> richChanges() { return richTextChanges; }


/**************************************************************************
/* ********************************************************************** *
* *
* Private fields *
* *
**************************************************************************/
* ********************************************************************** */

private Position selectionStart2D;
private Position selectionEnd2D;
Expand Down Expand Up @@ -285,11 +285,11 @@ public void setUndoManager(UndoManagerFactory undoManagerFactory) {
private final Guardian omniGuardian;


/**************************************************************************
/* ********************************************************************** *
* *
* Constructors *
* *
**************************************************************************/
* ********************************************************************** */

/**
* Creates a text area with empty text content.
Expand Down Expand Up @@ -369,13 +369,13 @@ public <C> StyledTextArea(S initialStyle, BiConsumer<Text, S> applyStyle,
}


/**************************************************************************
/* ********************************************************************** *
* *
* Queries *
* *
* Queries are parameterized observables. *
* *
**************************************************************************/
* ********************************************************************** */

@Override
public final String getText(int start, int end) {
Expand Down Expand Up @@ -534,14 +534,14 @@ public Position offsetToPosition(int charOffset, Bias bias) {
}


/**************************************************************************
/* ********************************************************************** *
* *
* Actions *
* *
* Actions change the state of this control. They typically cause a *
* change of one or more observables and/or produce an event. *
* *
**************************************************************************/
* ********************************************************************** */

/**
* Sets style for the given character range.
Expand Down Expand Up @@ -667,11 +667,11 @@ public void positionCaret(int pos) {
}


/**************************************************************************
/* ********************************************************************** *
* *
* Look &amp; feel *
* *
**************************************************************************/
* ********************************************************************** */

@Override
protected Skin<?> createDefaultSkin() {
Expand All @@ -690,11 +690,11 @@ protected Skin<?> createDefaultSkin() {
}


/**************************************************************************
/* ********************************************************************** *
* *
* Private methods *
* *
**************************************************************************/
* ********************************************************************** */

private UndoManager createPlainUndoManager(UndoManagerFactory factory) {
Consumer<PlainTextChange> apply = change -> replaceText(change.getPosition(), change.getPosition() + change.getRemoved().length(), change.getInserted());
Expand Down
1 change: 0 additions & 1 deletion richtextfx/src/main/java/org/fxmisc/richtext/behavior/CodeAreaBehavior.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ public void setCodeAreaSkin(StyledTextAreaSkin<S> skin) {

/**
* Records the last KeyEvent we saw.
* @param e
*/
@Override protected void callActionForEvent(KeyEvent e) {
lastEvent = e;
Expand Down

0 comments on commit 8f4a637

Please sign in to comment.