Add documentation for updated code

Author: psx95

sdk/include/opentelemetry/sdk/metrics/meter_config.h

@@ -10,17 +10,42 @@ namespace sdk
 {
 namespace metrics
 {
+/**
+ * MeterConfig defines various configurable aspects of a Meter's behavior.
+ * This class should not be used directly to configure a Meter's behavior, instead a
+ * ScopeConfigurator should be used to compute the desired MeterConfig which can then be used to
+ * configure a Meter.
+ */
 class MeterConfig
 {
 public:
   bool operator==(const MeterConfig &other) const noexcept;
 
+  /**
+   * Returns if the Meter is enabled or disabled. Meters are enabled by default.
+   * @return a boolean indicating if the Meter is enabled. Defaults to true.
+   */
   bool IsEnabled() const noexcept;
 
+  /**
+   * Returns a MeterConfig that represents a disabled Meter. A disabled meter behaves like a
+   * no-op meter.
+   * @return a static constant MeterConfig that represents a disabled meter.
+   */
   static MeterConfig Disabled();
 
+  /**
+   * Returns a MeterConfig that represents an enabled Meter.
+   * @return a static constant MeterConfig that represents an enabled meter.
+   */
   static MeterConfig Enabled();
 
+  /**
+   * Returns a MeterConfig that represents a Meter configured with the default behavior.
+   * The default behavior is guided by the OpenTelemetry specification.
+   * @return a static constant MeterConfig that represents a meter configured with default
+   * behavior.
+   */
   static MeterConfig Default();
 
 private:
@@ -31,4 +56,4 @@ class MeterConfig
 };
 }  // namespace metrics
 }  // namespace sdk
-OPENTELEMETRY_END_NAMESPACE
+OPENTELEMETRY_END_NAMESPACE

sdk/include/opentelemetry/sdk/metrics/meter_context.h

@@ -75,16 +75,20 @@ class MeterContext : public std::enable_shared_from_this<MeterContext>
    */
   ViewRegistry *GetViewRegistry() const noexcept;
 
+  /**
+   * Obtain the ScopeConfigurator with this meter context.
+   * @return The ScopeConfigurator for this meter context.
+   */
   const instrumentationscope::ScopeConfigurator<MeterConfig> &GetMeterConfigurator() const noexcept;
 
   /**
-   * NOTE - INTERNAL method, can change in future.
+   * NOTE - INTERNAL method, can change in the future.
    * Process callback for each meter in thread-safe manner
    */
   bool ForEachMeter(nostd::function_ref<bool(std::shared_ptr<Meter> &meter)> callback) noexcept;
 
   /**
-   * NOTE - INTERNAL method, can change in future.
+   * NOTE - INTERNAL method, can change in the future.
    * Get the configured meters.
    * This method is NOT thread safe, and only called through MeterProvider
    *

sdk/include/opentelemetry/sdk/metrics/meter_context_factory.h

@@ -23,16 +23,35 @@ class OPENTELEMETRY_EXPORT MeterContextFactory
 {
 public:
   /**
-   * Create a MeterContext.
+   * Create a MeterContext with valid defaults.
+   * @return A unique pointer to the created MeterContext object.
    */
   static std::unique_ptr<MeterContext> Create();
 
+  /**
+   * Create a MeterContext with specified views.
+   * @param views ViewRegistry containing OpenTelemetry views registered with this meter context.
+   */
   static std::unique_ptr<MeterContext> Create(std::unique_ptr<ViewRegistry> views);
 
+  /**
+   * Create a MeterContext with specified views and resource.
+   * @param views ViewRegistry containing OpenTelemetry views registered with this meter context.
+   * @param resource The OpenTelemetry resource associated with this meter context.
+   * @return A unique pointer to the created MeterContext object.
+   */
   static std::unique_ptr<MeterContext> Create(
       std::unique_ptr<ViewRegistry> views,
       const opentelemetry::sdk::resource::Resource &resource);
 
+  /**
+   * Create a MeterContext with specified views, resource and meter scope configurator.
+   * @param views ViewRegistry containing OpenTelemetry views registered with this meter context.
+   * @param resource The OpenTelemetry resource associated with this meter context.
+   * @param meter_configurator A scope configurator defining the behavior of a meter associated with
+   * this meter context.
+   * @return A unique pointer to the created MeterContext object.
+   */
   static std::unique_ptr<MeterContext> Create(
       std::unique_ptr<ViewRegistry> views,
       const opentelemetry::sdk::resource::Resource &resource,

sdk/include/opentelemetry/sdk/metrics/meter_provider.h

@@ -37,9 +37,11 @@ class OPENTELEMETRY_EXPORT MeterProvider final : public opentelemetry::metrics::
 {
 public:
   /**
-   * Initialize a new meter provider
+   * Initialize a new meter provider.
    * @param views The views for this meter provider
    * @param resource  The resources for this meter provider.
+   * @param meter_configurator Provides access to a function that computes the MeterConfig for
+   * Meters provided by this MeterProvider.
    */
   MeterProvider(
       std::unique_ptr<ViewRegistry> views     = std::unique_ptr<ViewRegistry>(new ViewRegistry()),

sdk/src/metrics/meter_config.cc

@@ -38,4 +38,4 @@ MeterConfig MeterConfig::Default()
 
 }  // namespace metrics
 }  // namespace sdk
-OPENTELEMETRY_END_NAMESPACE
+OPENTELEMETRY_END_NAMESPACE