Improve method docs.

Also, annotate with @param and @return. Signed-off-by: Raul Gutierrez Segales <[email protected]>
envoyproxy · May 3, 2018 · b24da82 · b24da82
1 parent 663c922
commit b24da82
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/include/envoy/router/router.h b/include/envoy/router/router.h
@@ -351,9 +351,11 @@ class MetadataMatchCriteria {
 
   /**
    * Creates a new MetadataMatchCriteria, merging existing
-   * metadata criteria this criteria. The result criteria is the
-   * combination of both sets of criteria, with those from the
+   * metadata criteria with the provided criteria. The result criteria is the
+   * combination of both sets of criteria, with those from the metadata_matches
    * ProtobufWkt::Struct taking precedence.
+   * @param metadata_matches supplies the new criteria.
+   * @return MetadataMatchCriteriaConstPtr the result criteria.
    */
   virtual MetadataMatchCriteriaConstPtr
   mergeMatchCriteria(const ProtobufWkt::Struct& metadata_matches) const PURE;