Skip to content

Commit d7f02bb

Browse files
committed
[CHORE] Say what recordCompletion returns in the comment that describes it
The sentence about the return value went in as a second comment stacked under the block that was already there, which leaves one declaration carrying two doc comments and Doxygen reading only the last of them. It belongs in the block. Signed-off-by: thc1006 <84045975+thc1006@users.noreply.github.com>
1 parent a5a6116 commit d7f02bb

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

‎exporters/elasticsearch/src/es_log_record_exporter.cc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,9 @@ class ResponseHandler : public http_client::EventHandler
230230
/**
231231
* Record the outcome of the request, first writer wins, then release any waiter. Keeping the
232232
* first outcome means a session destroyed after a successful response does not overwrite it.
233+
*
234+
* @return whether this call is the one that decided the outcome
233235
*/
234-
/// Returns whether this call is the one that decided the outcome.
235236
bool recordCompletion(CompletionState state)
236237
{
237238
bool recorded = false;

0 commit comments

Comments
 (0)