Skip to content

Commit b30499d

Browse files
author
nicolaiparlog
committed
Improve package documentations
The first sentence is of special importance as it is used in the Javadoc package list and as such the first thing a user reads about the package. It should be terse and informative.
1 parent b3c1979 commit b30499d

File tree

12 files changed

+24
-30
lines changed

12 files changed

+24
-30
lines changed

src/main/java/org/codefx/libfx/collection/transform/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* <p>
3-
* This package contains transforming collections.
3+
* Provides transforming collections.
44
* </p>
55
* <h2>Overview</h2>
66
* <p>

src/main/java/org/codefx/libfx/collection/tree/navigate/package-info.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/**
2-
* This package provides an abstraction to navigate <a
3-
* href="http://en.wikipedia.org/wiki/Tree_%28data_structure%29">tree</a>-like data structures without requiring them to
4-
* implement a specific interface.
2+
* Provides an abstraction to navigate <a href="http://en.wikipedia.org/wiki/Tree_%28data_structure%29">tree</a>-like
3+
* data structures without requiring them to implement a specific interface.
54
* <p>
65
* It contains the {@link org.codefx.libfx.collection.tree.navigate.TreeNavigator TreeNavigator} interface and several
76
* implementations, e.g. for AWT, Swing and JavaFX component hierarchies.

src/main/java/org/codefx/libfx/collection/tree/package-info.java

Lines changed: 0 additions & 9 deletions
This file was deleted.

src/main/java/org/codefx/libfx/collection/tree/stream/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* This package provides functionality around streaming the elements of <a
2+
* Provides the possibility to stream the elements of <a
33
* href="http://en.wikipedia.org/wiki/Tree_%28data_structure%29">tree</a>-like data structures.
44
* <p>
55
* Its main purpose is to enable easy creation of {@link java.util.stream.Stream Stream}s of nodes over tree-like data

src/main/java/org/codefx/libfx/concurrent/when/package-info.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/**
2-
* With {@link org.codefx.libfx.concurrent.when.ExecuteOnceWhen ExecuteOnceWhen} and
3-
* {@link org.codefx.libfx.concurrent.when.ExecuteAlwaysWhen ExecuteAlwaysWhen} this package provides two classes which
4-
* help to make sure some action which is triggered by a change on an {@link javafx.beans.value.ObservableValue
5-
* ObservableValue} gets executed under threading. Refer to the two classes for a detailed description.
2+
* Allows to make sure some action which is triggered by a change on an {@link javafx.beans.value.ObservableValue
3+
* ObservableValue} gets executed under threading.
64
* <p>
7-
* Instances of those classes can be built with {@link org.codefx.libfx.concurrent.when.ExecuteWhen ExecuteWhen}.
5+
* Refer to the two classes {@link org.codefx.libfx.concurrent.when.ExecuteOnceWhen ExecuteOnceWhen} and
6+
* {@link org.codefx.libfx.concurrent.when.ExecuteAlwaysWhen ExecuteAlwaysWhen} for a detailed description. Instances of
7+
* those classes can be built with {@link org.codefx.libfx.concurrent.when.ExecuteWhen ExecuteWhen}.
88
*
99
* @see org.codefx.libfx.concurrent.when.ExecuteWhen ExecuteWhen
1010
*/
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
2-
* This package provides functionality around UI Controls. Subpackages might provide additional functionality for
3-
* existing Swing or JavaFX controls, implement new ones or provide other features related to controls.
2+
* Provides functionality around UI Controls. Subpackages might provide additional functionality for existing Swing or
3+
* JavaFX controls, implement new ones or provide other features related to controls.
44
*/
55
package org.codefx.libfx.control;
66

src/main/java/org/codefx/libfx/control/properties/package-info.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/**
2+
* Makes using a {@link javafx.scene.control.Control Control}'s {@link javafx.scene.control.Control#getProperties()
3+
* propertyMap} more convenient.
24
* <p>
3-
* This package provides functionality to make using a {@link javafx.scene.control.Control Control}'s
4-
* {@link javafx.scene.control.Control#getProperties() propertyMap} easier. As such its main use will be to creators of
5-
* controls.
5+
* As such its main use will be to creators of controls.
66
* </p>
77
* <h2>Listening to the Property Map</h2>
88
* <p>

src/main/java/org/codefx/libfx/control/webview/package-info.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* <p>
3-
* This package provides functionality around JavaFX' {@link javafx.scene.web.WebView WebView}. All of it can be
4-
* accessed via the utility class {@link org.codefx.libfx.control.webview.WebViews WebViews}.
3+
* Provides functionality surrounding JavaFX' {@link javafx.scene.web.WebView WebView}. All of it can be accessed via
4+
* the utility class {@link org.codefx.libfx.control.webview.WebViews WebViews}.
55
* </p>
66
* <h2>Hyperlink Listener</h2>
77
* <p>

src/main/java/org/codefx/libfx/dom/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* <p>
3-
* This package provides functionality around DOM, i.e. classes from {@code org.w3c.dom}.
3+
* Provides functionality around DOM, i.e. classes from {@code org.w3c.dom}.
44
* </p>
55
* <h2>Event Conversion</h2> The class {@link org.codefx.libfx.dom.DomEventConverter DomEventConverter} defines methods
66
* which allow the conversion of {@link org.w3c.dom.events.Event DOM Events} to {@link javax.swing.event.HyperlinkEvent

src/main/java/org/codefx/libfx/listener/handle/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* This package provides classes which make it easier to add and remove listeners from observable instances.
2+
* Provides classes which make it easier to add and remove listeners from observable instances.
33
* <p>
44
* Using the default JavaFX 8 features, it is necessary to store both the observed instance and the listener if the
55
* latter has to be added or removed repeatedly. A {@link org.codefx.libfx.listener.handle.ListenerHandle

0 commit comments

Comments
 (0)