Skip to content

Commit

Permalink
Fix a/an typos (openhab#3184)
Browse files Browse the repository at this point in the history
  • Loading branch information
dilyanpalauzov authored Nov 30, 2022
1 parent 952b115 commit f64874e
Show file tree
Hide file tree
Showing 22 changed files with 25 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ public void refreshSource() {
}

/**
* Add an {@link MarketplaceAddonHandler) to this service
* Add a {@link MarketplaceAddonHandler) to this service
*
* This needs to be implemented by the addon-services because the handlers are references to OSGi services and
* the @Reference annotation is not inherited.
Expand All @@ -134,7 +134,7 @@ public void refreshSource() {
protected abstract void addAddonHandler(MarketplaceAddonHandler handler);

/**
* Remove an {@link MarketplaceAddonHandler) from this service
* Remove a {@link MarketplaceAddonHandler) from this service
*
* This needs to be implemented by the addon-services because the handlers are references to OSGi services and
* unbind methods can't be inherited.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ private String getContentType(@Nullable Integer category, List<String> tags) {
}

/**
* Transforms a {@link DiscourseTopicItem} to a {@link Addon}
* Transforms a {@link DiscourseTopicItem} to an {@link Addon}
*
* @param topic the topic
* @return the list item
Expand Down Expand Up @@ -344,7 +344,7 @@ private String unescapeEntities(String content) {
}

/**
* Transforms a {@link DiscourseTopicResponseDTO} to a {@link Addon}
* Transforms a {@link DiscourseTopicResponseDTO} to an {@link Addon}
*
* @param topic the topic
* @return the list item
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public interface AudioSink {
* If the passed {@link AudioStream} is not supported by this instance, an {@link UnsupportedAudioStreamException}
* is thrown.
*
* If the passed {@link AudioStream} has a {@link AudioFormat} not supported by this instance,
* If the passed {@link AudioStream} has an {@link AudioFormat} not supported by this instance,
* an {@link UnsupportedAudioFormatException} is thrown.
*
* In case the audioStream is null, this should be interpreted as a request to end any currently playing stream.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ public String toString() {
}

/**
* Converts a javax.sound.sampled.AudioFormat to a org.openhab.core.audio.AudioFormat
* Converts a javax.sound.sampled.AudioFormat to an org.openhab.core.audio.AudioFormat
*
* @param audioFormat the AudioFormat to convert
* @return The converted AudioFormat
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.eclipse.jdt.annotation.NonNullByDefault;

/**
* Expected execution of an {@link Rule}.
* Expected execution of a {@link Rule}.
*
* @author Sönke Küper - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@

/**
* The {@link ConfigDescriptionParameterGroupConverter} creates a {@link ConfigDescriptionParameterGroup} instance from
* a {@code option} XML
* node.
* an {@code option} XML node.
*
* @author Chris Jackson - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
public class AudioMapper {

/**
* Maps a {@link AudioSource} to an {@link AudioSourceDTO}.
* Maps an {@link AudioSource} to an {@link AudioSourceDTO}.
*
* @param source the audio source
* @param locale the locale to use for the DTO
Expand All @@ -39,7 +39,7 @@ public static AudioSourceDTO map(AudioSource source, Locale locale) {
}

/**
* Maps a {@link AudioSink} to an {@link AudioSinkDTO}.
* Maps an {@link AudioSink} to an {@link AudioSinkDTO}.
*
* @param sink the audio sink
* @param locale the locale to use for the DTO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ public String getJwtAccessToken(User user, String clientId, String scope, int to
}

/**
* Performs verifications on a JWT token, then parses it into a {@link AuthenticationException} instance
* Performs verifications on a JWT token, then parses it into an {@link AuthenticationException} instance
*
* @param jwt the base64-encoded JWT token from the request
* @return the {@link Authentication} derived from the information in the token
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
public class HLIMapper {

/**
* Maps a {@link HumanLanguageInterpreter} to an {@link HumanLanguageInterpreterDTO}.
* Maps a {@link HumanLanguageInterpreter} to a {@link HumanLanguageInterpreterDTO}.
*
* @param hli the human language interpreter
* @param locale the locale to use for the DTO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
public class VoiceMapper {

/**
* Maps a {@link Voice} to an {@link VoiceDTO}.
* Maps a {@link Voice} to a {@link VoiceDTO}.
*
* @param voice the voice
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public static boolean isLocation(Item item) {
}

/**
* Checks if the given {@link Item} is a {@link Equipment}.
* Checks if the given {@link Item} is an {@link Equipment}.
*
* @param item the Item to check
* @return return true, if the given Item is an Equipment, false otherwise
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import org.eclipse.jdt.annotation.NonNullByDefault;

/**
* The {@link RenamingTypeMigrator} is an {@link TypeMigrator} for renaming types
* The {@link RenamingTypeMigrator} is a {@link TypeMigrator} for renaming types
*
* @author Jan N. Klug - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

/**
* The {@link EventDescriptionConverter} is a concrete implementation of the {@code XStream} {@link Converter} interface
* used to convert a event description within an XML document into a {@link EventDescription} object.
* used to convert a event description within an XML document into an {@link EventDescription} object.
* <p>
* This converter converts {@code state} XML tags.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import org.openhab.core.thing.link.dto.ItemChannelLinkDTO;

/**
* A {@link ItemChannelLinkAddedEvent} notifies subscribers that an item channel link has been added.
* An {@link ItemChannelLinkAddedEvent} notifies subscribers that an item channel link has been added.
* Events must be created with the {@link LinkEventFactory}.
*
* @author Dennis Nobel - Initial contribution
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import org.openhab.core.thing.link.dto.ItemChannelLinkDTO;

/**
* A {@link ItemChannelLinkRemovedEvent} notifies subscribers that an item channel link has been removed.
* An {@link ItemChannelLinkRemovedEvent} notifies subscribers that an item channel link has been removed.
* Events must be created with the {@link LinkEventFactory}.
*
* @author Dennis Nobel - Initial contribution
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public enum AutoUpdatePolicy {
RECOMMEND;

/**
* Parses the input string into a {@link AutoUpdatePolicy}.
* Parses the input string into an {@link AutoUpdatePolicy}.
*
* @param input the input string
* @return the parsed AutoUpdatePolicy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public interface TransformationService {
/**
* Transforms the input <code>source</code> by means of the given <code>function</code> and returns the transformed
* output. The transformation may return <code>null</code> to express its operation resulted in a <code>null</code>
* output. In case of any error an {@link TransformationException} should be thrown.
* output. In case of any error a {@link TransformationException} should be thrown.
*
* @param function the function to be used to transform the input
* @param source the input to be transformed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public interface KSService {
* fired {@link KSEvent} events targeting the passed {@link KSListener}.
*
* The passed {@link AudioStream} must be of a supported {@link AudioFormat}.
* In other words a {@link AudioFormat} compatible with one returned from
* In other words an {@link AudioFormat} compatible with one returned from
* the {@code getSupportedFormats()} method.
*
* The passed {@code Locale} must be supported. That is to say it must be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public interface STTService {
* fired {@link STTEvent} events targeting the passed {@link STTListener}.
*
* The passed {@link AudioStream} must be of a supported {@link AudioFormat}.
* In other words a {@link AudioFormat} compatible with one returned from
* In other words an {@link AudioFormat} compatible with one returned from
* the {@code getSupportedFormats()} method.
*
* The passed {@code Locale} must be supported. That is to say it must be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public interface UserRegistry extends Registry<User, String>, AuthenticationProv
public User register(String username, String password, Set<String> roles);

/**
* Change the password for an {@link User} in this registry. The implementation receives the new password and is
* Change the password for a {@link User} in this registry. The implementation receives the new password and is
* responsible for their secure storage (for instance by hashing the password).
*
* @param username the username of the existing user
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ AccessTokenResponse getAccessTokenByImplicit(@Nullable String redirectURI, @Null
boolean isClosed();

/**
* Adds a {@link AccessTokenRefreshListener}.
* Adds an {@link AccessTokenRefreshListener}.
*
* @param listener the listener to add
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public final class EventOption {
private String label;

/**
* Creates a {@link EventOption} object.
* Creates an {@link EventOption} object.
*
* @param value value of the event
* @param label label
Expand Down

0 comments on commit f64874e

Please sign in to comment.