Skip to content

Commit

Permalink
Typos a/an (openhab#13812)
Browse files Browse the repository at this point in the history
Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>
  • Loading branch information
dilyanpalauzov authored and andrasU committed Dec 24, 2022
1 parent 3898f2f commit 48c7ceb
Show file tree
Hide file tree
Showing 105 changed files with 144 additions and 143 deletions.
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.ahawastecollection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ DateTime collectionDay_paper "Next paper collection" {channel="ahawastecollectio
```


Example for rule that sends an notification with collected waste types on day before collection
Example for rule that sends a notification with collected waste types on day before collection

```
triggers:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
public interface AhaCollectionScheduleFactory {

/**
* Creates an new {@link AhaCollectionSchedule} for the given location.
* Creates a new {@link AhaCollectionSchedule} for the given location.
*/
public AhaCollectionSchedule create(final String commune, final String street, final String houseNumber,
final String houseNumberAddon, final String collectionPlace);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ final class AhaCollectionScheduleImpl implements AhaCollectionSchedule {
private final String collectionPlace;

/**
* Creates an new {@link AhaCollectionScheduleImpl} for the given location.
* Creates a new {@link AhaCollectionScheduleImpl} for the given location.
*/
public AhaCollectionScheduleImpl(final String commune, final String street, final String houseNumber,
final String houseNumberAddon, final String collectionPlace) {
Expand Down Expand Up @@ -149,7 +149,7 @@ private CollectionDate parseRows(Element wasteTypeRow, Element collectionDatesRo
}

/**
* Returns <code>true</code> if the row is an (empty) delimiter row or if its an row that contains the download
* Returns <code>true</code> if the row is an (empty) delimiter row or if its a row that contains the download
* buttons for ical.
*/
private boolean isDelimiterOrDownloadRow(Element currentRow) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ public void initialize() {
}

/**
* Schedules an job that updates the collection dates at midnight.
* Schedules a job that updates the collection dates at midnight.
*/
private void restartJob() {
this.logger.debug("Restarting jobs for thing {}", this.getThing().getUID());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import org.eclipse.jdt.annotation.NonNullByDefault;

/**
* Contains the next collection dates for an given waste type.
* Contains the next collection dates for a given waste type.
*
* @author Sönke Küper - Initial contribution
*/
Expand Down Expand Up @@ -70,7 +70,7 @@ public static WasteType parseValue(String value) {
private final List<Date> dates;

/**
* Creates an new {@link CollectionDate}.
* Creates a new {@link CollectionDate}.
*/
public CollectionDate(final WasteType type, final List<Date> dates) {
this.type = type;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
</config-description>
</thing-type>

<!-- Channel type that represents the collection time of an waste type. -->
<!-- Channel type that represents the collection time of a waste type. -->
<channel-type id="collectionDateGeneralWaste">
<item-type>DateTime</item-type>
<label>General Waste</label>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ private static Configuration createConfig() {
}

/**
* Exception indicating that the execution of an script within the stub-Scheduler failed.
* Exception indicating that the execution of a script within the stub-Scheduler failed.
*/
private static class SchedulerRuntimeException extends RuntimeException {

Expand All @@ -70,7 +70,7 @@ public SchedulerRuntimeException(@Nullable final Throwable cause) {
}

/**
* Creates an {@link CronScheduler} that executes all commands synchronous.
* Creates a {@link CronScheduler} that executes all commands synchronous.
*/
@SuppressWarnings("unchecked")
private static CronScheduler createStubScheduler() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import de.kaizencode.tchaikovsky.exception.SpeakerException;

/**
* The {@link AllPlayAudioSink} make AllPlay speakers available as a {@link AudioSink}.
* The {@link AllPlayAudioSink} make AllPlay speakers available as an {@link AudioSink}.
*
* @author Dominic Lerbs - Initial contribution
*/
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.amazonechocontrol/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ then
end
```

## Playing an alarm sound for 15 seconds with an openHAB rule if an door contact was opened:
## Playing an alarm sound for 15 seconds with an openHAB rule if a door contact was opened:

1) Do get the ID of your sound, follow the steps in "How To Get IDs"
2) Write down the text in the square brackets. e.g. ECHO:system_alerts_repetitive01 for the nightstand sound
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ synchronized void setSmartHomeDevices(List<SmartHomeBaseDevice> deviceList) {
Set<SmartHomeDevice> supportedChildren = SmartHomeDeviceHandler.getSupportedSmartHomeDevices(shg,
deviceList);
if (supportedChildren.isEmpty()) {
// No children with an supported interface
// No children with a supported interface
continue;
}
thingUID = new ThingUID(THING_TYPE_SMART_HOME_DEVICE_GROUP, bridgeThingUID, id.replace(".", "-"));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* Defines an implementation of {@link AtlonaHandlerCallback} that will remember the last state
* for an channelId and suppress the callback if the state hasn't changed
* for a channelId and suppress the callback if the state hasn't changed
*
* @author Tim Roberts - Initial contribution
*/
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.bluetooth.bluegiga/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Additionally, the parameter `backgroundDiscovery` can be set to true/false. When

## Example

This is how an BlueGiga adapter can be configured textually in a *.things file:
This is how a BlueGiga adapter can be configured textually in a *.things file:

```
Bridge bluetooth:bluegiga:1 [ port="/dev/ttyS0", backgroundDiscovery=false ]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ private void removeTransactionListener(BluetoothListener<?> listener) {
}

/**
* Sends an BlueGiga request without waiting for the response.
* Sends a BlueGiga request without waiting for the response.
*
* @param bleCommand {@link BlueGigaCommand}
* @return response {@link Future} {@link BlueGigaResponse}
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.bluetooth.bluez/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Additionally, the parameter `backgroundDiscovery` can be set to true/false.When

## Example

This is how an BlueZ adapter can be configured textually in a *.things file:
This is how a BlueZ adapter can be configured textually in a *.things file:

```
Bridge bluetooth:bluez:hci0 [ address="12:34:56:78:90:AB", backgroundDiscovery=false ]
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.bluetooth.roaming/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The `backgroundDiscovery` parameter is true by default.

## Example

This is how an Roaming adapter can be configured textually in a *.things file:
This is how a Roaming adapter can be configured textually in a *.things file:

```
Bridge bluetooth:roaming:ctrl "BLE Roaming Adapter" [ backgroundDiscovery=true]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

/**
* The {@link BluetoothAdapter} class defines the standard adapter API that must be implemented by bridge handlers,
* which are then required to be registered as an BluetoothAdapter OSGi service.
* which are then required to be registered as a BluetoothAdapter OSGi service.
* <p>
* <b>Scanning</b>
* The API assumes that the adapter is "always" scanning to enable beacons to be received.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public class DarkSkyDiscoveryService extends AbstractDiscoveryService {
private final DarkSkyAPIHandler bridgeHandler;

/**
* Creates an DarkSkyLocationDiscoveryService.
* Creates a DarkSkyLocationDiscoveryService.
*/
public DarkSkyDiscoveryService(DarkSkyAPIHandler bridgeHandler, LocationProvider locationProvider,
LocaleProvider localeProvider, TranslationProvider i18nProvider) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
package org.openhab.binding.darksky.internal.model;

/**
* The {@link DarkSkyCurrentlyData} is the Java class used to map the JSON response to an Dark Sky request.
* The {@link DarkSkyCurrentlyData} is the Java class used to map the JSON response to a Dark Sky request.
*
* @author Christoph Weitkamp - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.eclipse.jdt.annotation.Nullable;

/**
* The {@link DarkSkyDailyData} is the Java class used to map the JSON response to an Dark Sky request.
* The {@link DarkSkyDailyData} is the Java class used to map the JSON response to a Dark Sky request.
*
* @author Christoph Weitkamp - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.eclipse.jdt.annotation.Nullable;

/**
* The {@link DarkSkyHourlyData} is the Java class used to map the JSON response to an Dark Sky request.
* The {@link DarkSkyHourlyData} is the Java class used to map the JSON response to a Dark Sky request.
*
* @author Christoph Weitkamp - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.eclipse.jdt.annotation.Nullable;

/**
* The {@link DarkSkyJsonWeatherData} is the Java class used to map the JSON response to an Dark Sky request.
* The {@link DarkSkyJsonWeatherData} is the Java class used to map the JSON response to a Dark Sky request.
*
* @author Christoph Weitkamp - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import org.openhab.core.types.State;

/**
* Accessor for attribute value of an DTO-Object.
* Accessor for attribute value of a DTO-Object.
*
* @author Sönke Küper - Initial contribution.
*
Expand All @@ -41,7 +41,7 @@ public abstract class AbstractDtoAttributeSelector<DTO_TYPE extends JaxbEntity,
private final Function<VALUE_TYPE, List<String>> valueToList;

/**
* Creates an new {@link EventAttribute}.
* Creates a new {@link EventAttribute}.
*
* @param getter Function to get the raw value.
* @param setter Function to set the raw value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import org.openhab.core.types.State;

/**
* Selection of an attribute within an {@link TimetableStop} that provides a channel {@link State}.
* Selection of an attribute within a {@link TimetableStop} that provides a channel {@link State}.
*
* @author Sönke Küper - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
import org.slf4j.LoggerFactory;

/**
* Handler for an Train-Thing in DeutscheBahn Binding.
* Handler for a Train-Thing in DeutscheBahn Binding.
*
* Represents an Train that arrives / departs at the station selected by the DeutscheBahnTimetable-Bridge.
* Represents a Train that arrives / departs at the station selected by the DeutscheBahnTimetable-Bridge.
*
* @author Sönke Küper - Initial contribution
*/
Expand All @@ -49,7 +49,7 @@ private final class ChannelWithConfig {
private final AttributeSelection attributeSelection;

/**
* Creates an new ChannelWithConfig.
* Creates a new ChannelWithConfig.
*
* @param channelUid The UID of the channel
* @param attributeSelection The attribute that provides the state that will be displayed.
Expand Down Expand Up @@ -88,7 +88,7 @@ public String toString() {
private final List<ChannelWithConfig> configuredChannels = new ArrayList<>();

/**
* Creates an new {@link DeutscheBahnTrainHandler}.
* Creates a new {@link DeutscheBahnTrainHandler}.
*/
public DeutscheBahnTrainHandler(Thing thing) {
super(thing);
Expand Down Expand Up @@ -123,7 +123,7 @@ private void createChannelMapping() {
}

/**
* Creates an {@link ChannelWithConfig} for an channel that represents an attribute of an
* Creates a {@link ChannelWithConfig} for a channel that represents an attribute of an
* {@link org.openhab.binding.deutschebahn.internal.timetable.dto.TripLabel}.
*/
private void createTripChannelConfiguration(Channel channel) {
Expand All @@ -141,7 +141,7 @@ private void createTripChannelConfiguration(Channel channel) {
}

/**
* Creates the {@link ChannelWithConfig} for an channel that represents an attribute of an
* Creates the {@link ChannelWithConfig} for a channel that represents an attribute of an
* {@link org.openhab.binding.deutschebahn.internal.timetable.dto.Event}.}
*/
private void createEventChannelConfiguration(EventType eventType, Channel channel) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ public final class EventAttribute<VALUE_TYPE, STATE_TYPE extends State>
private static final SimpleDateFormat DATETIME_FORMAT = new SimpleDateFormat("yyMMddHHmm");

/**
* Creates an new {@link EventAttribute}.
* Creates a new {@link EventAttribute}.
*
* @param getter Function to get the raw value.
* @param setter Function to set the raw value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public final class EventAttributeSelection implements AttributeSelection {
private final EventAttribute<?, ?> eventAttribute;

/**
* Creates an new {@link EventAttributeSelection}.
* Creates a new {@link EventAttributeSelection}.
*/
public EventAttributeSelection(EventType eventType, EventAttribute<?, ?> eventAttribute) {
this.eventType = eventType;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import org.openhab.binding.deutschebahn.internal.timetable.dto.TimetableStop;

/**
* Type of an {@link Event} within an {@link TimetableStop}.
* Type of an {@link Event} within a {@link TimetableStop}.
*
* @author Sönke Küper - initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import org.openhab.core.types.UnDefType;

/**
* Selection that returns the value of an {@link TripLabel}.
* Selection that returns the value of a {@link TripLabel}.
*
* chapter "1.2.7 TripLabel" in Technical Interface Description for external Developers
*
Expand Down Expand Up @@ -73,7 +73,7 @@ public final class TripLabelAttribute<VALUE_TYPE, STATE_TYPE extends State> exte
TripLabel::setO, StringType::new, TripLabelAttribute::singletonList, StringType.class);

/**
* Creates an new {@link TripLabelAttribute}.
* Creates a new {@link TripLabelAttribute}.
*
* @param getter Function to get the raw value.
* @param setter Function to set the raw value.
Expand Down Expand Up @@ -133,7 +133,7 @@ private static List<String> singletonList(@Nullable String value) {
}

/**
* Returns an {@link TripLabelAttribute} for the given channel-name.
* Returns a {@link TripLabelAttribute} for the given channel-name.
*/
@Nullable
public static TripLabelAttribute<?, ?> getByChannelName(final String channelName) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public final class AndPredicate implements TimetableStopPredicate {
private final TimetableStopPredicate second;

/**
* Creates an new {@link AndPredicate}.
* Creates a new {@link AndPredicate}.
*/
public AndPredicate(TimetableStopPredicate first, TimetableStopPredicate second) {
this.first = first;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public final class ChannelNameEquals extends FilterToken {
private final String channelGroup;

/**
* Creates an new {@link ChannelNameEquals}.
* Creates a new {@link ChannelNameEquals}.
*/
public ChannelNameEquals(int position, String channelGroup, String channelName, Pattern filterPattern) {
super(position);
Expand Down Expand Up @@ -75,7 +75,7 @@ public <R> R accept(FilterTokenVisitor<R> visitor) throws FilterParserException
}

/**
* Maps this into an {@link TimetableStopByStringEventAttributeFilter}.
* Maps this into a {@link TimetableStopByStringEventAttributeFilter}.
*/
public TimetableStopByStringEventAttributeFilter mapToPredicate() throws FilterParserException {
return new TimetableStopByStringEventAttributeFilter(mapAttributeSelection(), filterValue);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import org.eclipse.jdt.annotation.Nullable;

/**
* Parses an {@link FilterToken}-Sequence into a {@link TimetableStopPredicate}.
* Parses a {@link FilterToken}-Sequence into a {@link TimetableStopPredicate}.
*
* @author Sönke Küper - Initial contribution.
*/
Expand Down Expand Up @@ -287,7 +287,7 @@ private FilterParser() {
}

/**
* Parses the given {@link FilterToken} into an {@link TimetableStopPredicate}.
* Parses the given {@link FilterToken} into a {@link TimetableStopPredicate}.
*/
public static TimetableStopPredicate parse(final List<FilterToken> tokens) throws FilterParserException {
State state = new InitialState();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public final class FilterParserException extends Exception {
private static final long serialVersionUID = 3104578924298682889L;

/**
* Creates an new {@link FilterParserException}.
* Creates a new {@link FilterParserException}.
*/
public FilterParserException(String message) {
super(message);
Expand Down
Loading

0 comments on commit 48c7ceb

Please sign in to comment.