Fix a/an typos (#3184)

2026-07-29 12:34:22 +02:00 · 2022-11-30 21:16:18 +01:00
parent 952b11560a
commit f64874e226
22 changed files with 25 additions and 26 deletions
@@ -123,7 +123,7 @@ public abstract class AbstractRemoteAddonService implements AddonService {
    }

    /**
-     * 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.
@@ -134,7 +134,7 @@ public abstract class AbstractRemoteAddonService implements AddonService {
    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.
@@ -272,7 +272,7 @@ public class CommunityMarketplaceAddonService extends AbstractRemoteAddonService
    }

    /**
-     * Transforms a {@link DiscourseTopicItem} to a {@link Addon}
+     * Transforms a {@link DiscourseTopicItem} to an {@link Addon}
     *
     * @param topic the topic
     * @return the list item
@@ -344,7 +344,7 @@ public class CommunityMarketplaceAddonService extends AbstractRemoteAddonService
    }

    /**
-     * Transforms a {@link DiscourseTopicResponseDTO} to a {@link Addon}
+     * Transforms a {@link DiscourseTopicResponseDTO} to an {@link Addon}
     *
     * @param topic the topic
     * @return the list item
@@ -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.
@@ -229,7 +229,7 @@ public class JavaSoundAudioSource implements AudioSource {
    }

    /**
-     * 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
@@ -17,7 +17,7 @@ import java.util.Date;
 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
 */
@@ -24,8 +24,7 @@ import com.thoughtworks.xstream.io.HierarchicalStreamReader;

 /**
 * The {@link ConfigDescriptionParameterGroupConverter} creates a {@link ConfigDescriptionParameterGroup} instance from
- * a {@code option} XML
- * node.
+ * an {@code option} XML node.
 *
 * @author Chris Jackson - Initial contribution
 */
@@ -27,7 +27,7 @@ import org.openhab.core.audio.AudioSource;
 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
@@ -39,7 +39,7 @@ public class AudioMapper {
    }

    /**
-     * 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
@@ -133,7 +133,7 @@ public class JwtHelper {
    }

    /**
-     * 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
@@ -28,7 +28,7 @@ import org.openhab.core.voice.text.HumanLanguageInterpreter;
 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
@@ -24,7 +24,7 @@ import org.openhab.core.voice.Voice;
 public class VoiceMapper {

    /**
-     * Maps a {@link Voice} to an {@link VoiceDTO}.
+     * Maps a {@link Voice} to a {@link VoiceDTO}.
     *
     * @param voice the voice
     *
@@ -45,7 +45,7 @@ public class Semantics {
    }

    /**
-     * 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
@@ -15,7 +15,7 @@ package org.openhab.core.storage.json.internal.migration;
 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
 */
@@ -32,7 +32,7 @@ import com.thoughtworks.xstream.io.HierarchicalStreamReader;

 /**
 * 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.
 *
@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 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
@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -277,7 +277,7 @@ public interface OAuthClientService extends AutoCloseable {
    boolean isClosed();

    /**
-     * Adds a {@link AccessTokenRefreshListener}.
+     * Adds an {@link AccessTokenRefreshListener}.
     *
     * @param listener the listener to add
     */
@@ -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