chore: fix some misnamed parameters in doxygen comments (#126)

Author: cwaldren-ld

libs/client-sdk/include/launchdarkly/client_side/client.hpp

@@ -21,6 +21,11 @@ namespace launchdarkly::client_side {
  */
 class IClient {
    public:
+    /**
+     * Represents the key of a feature flag.
+     */
+    using FlagKey = std::string;
+
     /** Connects the client to LaunchDarkly's flag delivery endpoints.
      *
      * If StartAsync isn't called, the client is able to post events but is
@@ -49,14 +54,13 @@ class IClient {
     [[nodiscard]] virtual bool Initialized() const = 0;
 
     /**
-     * Returns a map from feature flag keys to <see cref="LdValue"/> feature
+     * Returns a map from feature flag keys to feature
      * flag values for the current context.
      *
      * This method will not send analytics events back to LaunchDarkly.
      *
-     * @return a map from feature flag keys to values for the current context
+     * @return A map from feature flag keys to values for the current context.
      */
-    using FlagKey = std::string;
     [[nodiscard]] virtual std::unordered_map<FlagKey, Value> AllFlags()
         const = 0;
 

libs/common/include/launchdarkly/config/shared/builders/data_source_builder.hpp

@@ -184,7 +184,7 @@ class DataSourceBuilder<ServerSDK> {
      * @param stream_builder The streaming builder.
      * @return Reference to this builder.
      */
-    DataSourceBuilder& Method(Streaming builder);
+    DataSourceBuilder& Method(Streaming stream_builder);
 
     /**
      * Set the polling configuration for the builder.
@@ -196,7 +196,7 @@ class DataSourceBuilder<ServerSDK> {
      * @param polling_builder The polling builder.
      * @return Reference to this builder.
      */
-    DataSourceBuilder& Method(Polling builder);
+    DataSourceBuilder& Method(Polling polling_builder);
 
     /**
      * Build a data source config. This is used internal to the SDK.

libs/common/include/launchdarkly/config/shared/builders/events_builder.hpp

@@ -86,8 +86,8 @@ class EventsBuilder {
      * necessary to call either of these methods, as the default behavior is to
      * treat all attributes as non-private unless otherwise specified.
      *
-     * @param value True for behavior of (1), false for default behavior of (2)
-     * or (3).
+     * @param all_attributes_private True for behavior of (1), false for default
+     * behavior of (2) or (3).
      * @return Reference to this builder.
      */
     EventsBuilder& AllAttributesPrivate(bool all_attributes_private);

libs/common/include/launchdarkly/config/shared/builders/http_properties_builder.hpp

@@ -61,7 +61,7 @@ class HttpPropertiesBuilder {
      * Set a write timeout. This is how long it takes to perform a Write
      * operation.
      *
-     * @param read_timeout The write timeout.
+     * @param write_timeout The write timeout.
      * @return A reference to this builder.
      */
     HttpPropertiesBuilder& WriteTimeout(

libs/common/include/launchdarkly/config/shared/built/events.hpp

@@ -32,8 +32,8 @@ class Events final {
      * private or not.
      * @param private_attrs Which attributes should be treated as private, if
      * AllAttributesPrivate is false.
-     * @param security Whether a plaintext or encrypted client should be used
-     * for event delivery.
+     * @param delivery_retry_delay How long to wait before a redelivery attempt
+     * should be made.
      * @param flush_workers How many workers to use for concurrent event
      * delivery.
      */

libs/common/include/launchdarkly/persistence/persistence.hpp

@@ -37,11 +37,11 @@ class IPersistence {
      *
      * @param storage_namespace The namespace for the data.
      * @param key The key for the data.
-     * @param value The data to add or update.
+     * @param data The data to add or update.
      */
     virtual void Set(std::string storage_namespace,
-                          std::string key,
-                          std::string data) noexcept = 0;
+                     std::string key,
+                     std::string data) noexcept = 0;
 
     /**
      * Remove a value from the store. If the value cannot be removed, then
@@ -51,7 +51,7 @@ class IPersistence {
      * @param key The key of the data.
      */
     virtual void Remove(std::string storage_namespace,
-                             std::string key) noexcept = 0;
+                        std::string key) noexcept = 0;
 
     /**
      * Attempt to read a value from the store.