Skip to content

Supplement doc comments in interface headers.#330

Merged
mum4k merged 2 commits intoenvoyproxy:masterfrom
oschaaf:add-doc-comments
Apr 28, 2020
Merged

Supplement doc comments in interface headers.#330
mum4k merged 2 commits intoenvoyproxy:masterfrom
oschaaf:add-doc-comments

Conversation

@oschaaf
Copy link
Copy Markdown
Member

@oschaaf oschaaf commented Apr 27, 2020

Fixes #268

Signed-off-by: Otto van der Schaaf oschaaf@we-amp.com

Fixes envoyproxy#268

Signed-off-by: Otto van der Schaaf <oschaaf@we-amp.com>
@oschaaf oschaaf added P2 waiting-for-review A PR waiting for a review. labels Apr 27, 2020
* @param dispatcher supplies the owning thread's dispatcher.
* @param scope stats scope for any stats tracked by the benchmark client.
* @param cluster_manager Cluster manager preconfigured with our target cluster.
* @param http_tracer http tracer
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(nit) Do we have anything more interesting to say about this, maybe what it is used for pr what it means in the context of this function? The current comment is kind of redundant.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, that wasn't a very helpful doc comment :-)
done in 28487f0

@mum4k mum4k added waiting-for-changes A PR waiting for comments to be resolved and changes to be applied. and removed waiting-for-review A PR waiting for a review. labels Apr 27, 2020
Signed-off-by: Otto van der Schaaf <oschaaf@we-amp.com>
@oschaaf oschaaf added waiting-for-review A PR waiting for a review. and removed waiting-for-changes A PR waiting for comments to be resolved and changes to be applied. labels Apr 27, 2020
@mum4k mum4k merged commit c09fdcf into envoyproxy:master Apr 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P2 waiting-for-review A PR waiting for a review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc comments check

2 participants