Review feedback: doc comments

oschaaf · oschaaf · commit 70502e1f2cea · 2020-08-29T18:53:59.000+02:00
Signed-off-by: Otto van der Schaaf &lt;oschaaf@we-amp.com&gt;
diff --git a/source/common/thread_safe_monotonic_time_stopwatch.h b/source/common/thread_safe_monotonic_time_stopwatch.h
@@ -8,7 +8,15 @@
 namespace Nighthawk {
 
 /**
- *  Utility class for thread safe tracking of elapsed monotonic time.
+ * Utility class for thread safe tracking of elapsed monotonic time.
+ * Example usage:
+ *
+ * ThreadSafeMontonicTimeStopwatch stopwatch;
+ * int i = 0;
+ * do {
+ *   std::cerr << stopwatch.getElapsedNsAndReset() <<
+ *    "ns elapsed since last iteration." << std::endl;
+ * } while (++i < 100);
  */
 class ThreadSafeMontonicTimeStopwatch : public Stopwatch {
 public:
diff --git a/source/server/http_time_tracking_filter.h b/source/server/http_time_tracking_filter.h
@@ -15,7 +15,7 @@ namespace Nighthawk {
 namespace Server {
 
 /**
- * Filter configuration container class for the test server extension.
+ * Filter configuration container class for the time tracking extension.
  * Instances of this class will be shared accross instances of HttpTimeTrackingFilter.
  */
 class HttpTimeTrackingFilterConfig {
@@ -56,9 +56,17 @@ class HttpTimeTrackingFilterConfig {
 
 using HttpTimeTrackingFilterConfigSharedPtr = std::shared_ptr<HttpTimeTrackingFilterConfig>;
 
+/**
+ * Extension that tracks elapsed time between inbound requests.
+ */
 class HttpTimeTrackingFilter : public Envoy::Http::PassThroughFilter {
 public:
-  HttpTimeTrackingFilter(HttpTimeTrackingFilterConfigSharedPtr);
+  /**
+   * Construct a new Http Time Tracking Filter object.
+   *
+   * @param config Configuration of the extension.
+   */
+  HttpTimeTrackingFilter(HttpTimeTrackingFilterConfigSharedPtr config);
 
   // Http::StreamDecoderFilter
   Envoy::Http::FilterHeadersStatus decodeHeaders(Envoy::Http::RequestHeaderMap& headers,
