Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace Markdown backticks with JavaDoc code tags #4023

Merged
merged 2 commits into from
Jan 20, 2024
Merged

Replace Markdown backticks with JavaDoc code tags #4023

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9409a93
Replace Markdown backticks with JavaDoc code tags
wborn Jan 6, 2024
4e9f7c7
Add back generics
wborn Jan 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/AudioManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ public interface AudioManager {
/**
* Get a list of source ids that match a given pattern
*
* @param pattern pattern to search, can include `*` and `?` placeholders
* @param pattern pattern to search, can include {@code *} and {@code ?} placeholders
* @return ids of matching sources
*/
Set<String> getSourceIds(String pattern);
Expand Down Expand Up @@ -248,7 +248,7 @@ public interface AudioManager {
/**
* Get a list of sink ids that match a given pattern
*
* @param pattern pattern to search, can include `*` and `?` placeholders
* @param pattern pattern to search, can include {@code *} and {@code ?} placeholders
* @return ids of matching sinks
*/
Set<String> getSinkIds(String pattern);
Expand Down
4 changes: 2 additions & 2 deletions ...onsole.karaf/src/main/java/org/openhab/core/io/console/karaf/internal/CommandWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ public class CommandWrapper implements Command, Action {

/**
* The constructor for the "help" instance of this class. This instance will be created by
* org.apache.karaf.shell.impl.action.command.ManagerImpl.instantiate(Class<? extends T>, Registry) and
* is used to print all usages from the `openhab` scope.
* {@code org.apache.karaf.shell.impl.action.command.ManagerImpl.instantiate(Class, Registry)} and
wborn marked this conversation as resolved.
Show resolved Hide resolved
* is used to print all usages from the {@code openhab} scope.
* The wrapped command is unused here because the karaf infrastructure will call the {@link #execute()} method.
*/
public CommandWrapper() {
Expand Down
4 changes: 2 additions & 2 deletions ...ansport.mqtt/src/test/java/org/openhab/core/io/transport/mqtt/MqttBrokerConnectionEx.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
import com.hivemq.client.mqtt.MqttClientState;

/**
* We need an extended MqttBrokerConnection to overwrite the protected `connectionCallbacks` with
* an instance that takes the mocked version of `MqttBrokerConnection` and overwrite the connection state.
* We need an extended MqttBrokerConnection to overwrite the protected {@link #connectionCallback} with
* an instance that takes the mocked version of {@link MqttBrokerConnection} and overwrite the connection state.
*
* We also mock the internal Mqtt3AsyncClient that in respect to the success flags
* immediately succeed or fail with publish, subscribe, unsubscribe, connect, disconnect.
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/Bridge.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* A {@link Bridge} is a {@link Thing} that connects other {@link Thing}s.
*
* @author Dennis Nobel - Initial contribution
* @author Christoph Weitkamp - Added method `getThing(ThingUID)`
* @author Christoph Weitkamp - Added method {@code getThing(ThingUID)}
*/
@NonNullByDefault
public interface Bridge extends Thing {
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/ChannelUID.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* @author Jochen Hiller - Bugfix 455434: added default constructor
* @author Dennis Nobel - Added channel group id
* @author Kai Kreuzer - Changed creation of channels to not require a thing type
* @author Christoph Weitkamp - Changed pattern for validating last segment to contain either a single `#` or none
* @author Christoph Weitkamp - Changed pattern for validating last segment to contain either a single {@code #} or none
*/
@NonNullByDefault
public class ChannelUID extends UID {
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/Thing.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* @author Simon Kaufmann - Added label, location
* @author Kai Kreuzer - Removed linked items from Thing
* @author Yordan Zhelev - Added method for getting the enabled status
* @author Christoph Weitkamp - Added method `getChannel(ChannelUID)`
* @author Christoph Weitkamp - Added method {@code getChannel(ChannelUID)}
*/
@NonNullByDefault
public interface Thing extends Identifiable<ThingUID> {
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/BridgeImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
/**
*
* @author Denis Nobel - Initial contribution
* @author Christoph Weitkamp - Added method `getThing(ThingUID)`
* @author Christoph Weitkamp - Added method {@code getThing(ThingUID)}
*/
@NonNullByDefault
public class BridgeImpl extends ThingImpl implements Bridge {
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/ThingImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
* ThingType Description
* @author Thomas Höfer - Added thing and thing type properties
* @author Simon Kaufmann - Added label
* @author Christoph Weitkamp - Added method `getChannel(ChannelUID)`
* @author Christoph Weitkamp - Added method {@code getChannel(ChannelUID)}
*/
@NonNullByDefault
public class ThingImpl implements Thing {
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/ChannelUIDTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* Tests for class {@link ChannelUID}.
*
* @author Simon Kaufmann - Initial contribution
* @author Christoph Weitkamp - Changed pattern for validating last segment to contain either a single `#` or none
* @author Christoph Weitkamp - Changed pattern for validating last segment to contain either a single {@code #} or none
*/
@NonNullByDefault
public class ChannelUIDTest {
Expand Down
4 changes: 2 additions & 2 deletions bundles/org.openhab.core/src/main/java/org/openhab/core/cache/ExpiringCacheAsync.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ public ExpiringCacheAsync(long expiry) {
* @param requestNewValueFuture If the value is expired, this supplier is called to supply the cache with a future
* that on completion will update the cached value
* @return the value in form of a CompletableFuture. You can for instance use it this way:
* `getValue().thenAccept(value->useYourValueHere(value));`. If you need the value synchronously you can use
* `getValue().get()`.
* {@code getValue().thenAccept(value->useYourValueHere(value));}. If you need the value synchronously you
* can use {@code getValue().get()}.
*/
public CompletableFuture<V> getValue(Supplier<CompletableFuture<V>> requestNewValueFuture) {
if (isExpired()) {
Expand Down
14 changes: 7 additions & 7 deletions bundles/org.openhab.core/src/main/java/org/openhab/core/util/ColorUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ public static int hsbTosRgb(HSBType hsb) {

/**
* Transform <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> based {@link HSBType} to
* <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">CIE 1931</a> `xy` format.
* <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">CIE 1931</a> {@code xy} format.
*
* See <a href=
* "https://developers.meethue.com/develop/application-design-guidance/color-conversion-formulas-rgb-to-xy-and-back/">Hue
Expand All @@ -242,7 +242,7 @@ public static double[] hsbToXY(HSBType hsb) {

/**
* Transform <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> based {@link HSBType} to
* <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">CIE 1931</a> `xy` format.
* <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">CIE 1931</a> {@code xy} format.
*
* See <a href=
* "https://developers.meethue.com/develop/application-design-guidance/color-conversion-formulas-rgb-to-xy-and-back/">Hue
Expand Down Expand Up @@ -398,7 +398,7 @@ public static HSBType rgbToHsb(PercentType[] rgb) throws IllegalArgumentExceptio
}

/**
* Transform <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">CIE 1931</a> `xy` format to
* Transform <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">CIE 1931</a> {@code xy} format to
* <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> based {@link HSBType}.
*
* See <a href=
Expand All @@ -414,7 +414,7 @@ public static HSBType xyToHsb(double[] xy) throws IllegalArgumentException {
}

/**
* Transform <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">CIE 1931</a> `xy` format to
* Transform <a href="https://en.wikipedia.org/wiki/CIE_1931_color_space">CIE 1931</a> {@code xy} format to
* <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> based {@link HSBType}.
*
* See <a href=
Expand Down Expand Up @@ -560,9 +560,9 @@ public record Gamut(double[] r, double[] g, double[] b) {
/**
* Color <a href="https://en.wikipedia.org/wiki/Gamut">gamut</a>
*
* @param r double array with `xy` coordinates for red, x, y between 0.0000 and 1.0000.
* @param g double array with `xy` coordinates for green, x, y between 0.0000 and 1.0000.
* @param b double array with `xy` coordinates for blue, x, y between 0.0000 and 1.0000.
* @param r double array with {@code xy} coordinates for red, x, y between 0.0000 and 1.0000.
* @param g double array with {@code xy} coordinates for green, x, y between 0.0000 and 1.0000.
* @param b double array with {@code xy} coordinates for blue, x, y between 0.0000 and 1.0000.
*/
public Gamut {
}
Expand Down