chore(telemetry): normalize remaining triple-slash Doxygen comments

Convert leading /// blocks in LedgerSpanNames.h and PeerSpanNames.h to
house-style /** */. Comment-only: code is byte-identical.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Pratik Mankawde
2026-07-20 17:42:26 +01:00
parent d17a406c2a
commit d63b2bfb50
2 changed files with 18 additions and 8 deletions

View File

@@ -1,6 +1,7 @@
#pragma once
/** Compile-time span name constants for ledger tracing.
/**
* Compile-time span name constants for ledger tracing.
*
* Used by BuildLedger and LedgerMaster for ledger lifecycle spans.
* Built on StaticStr/join() from SpanNames.h.
@@ -29,14 +30,18 @@ inline constexpr auto apply = makeStr("apply");
// ===== Attribute keys ========================================================
namespace attr {
/// Canonical shared constants (defined in SpanNames.h).
/**
* Canonical shared constants (defined in SpanNames.h).
*/
using ::xrpl::telemetry::attr::closeResolutionMs;
using ::xrpl::telemetry::attr::closeTime;
using ::xrpl::telemetry::attr::closeTimeCorrect;
using ::xrpl::telemetry::attr::ledgerHash;
using ::xrpl::telemetry::attr::ledgerSeq;
/// Domain-owned bare attrs.
/**
* Domain-owned bare attrs.
*/
inline constexpr auto txCount = makeStr("tx_count");
inline constexpr auto txFailed = makeStr("tx_failed");
inline constexpr auto validations = makeStr("validations");

View File

@@ -1,6 +1,7 @@
#pragma once
/** Compile-time span name constants for peer overlay tracing.
/**
* Compile-time span name constants for peer overlay tracing.
*
* Used by PeerImp for peer message handling spans (proposals,
* validations). Built on StaticStr/join() from SpanNames.h.
@@ -25,14 +26,18 @@ inline constexpr auto validationReceive = makeStr("validation.receive");
// ===== Attribute keys ========================================================
namespace attr {
/// Canonical shared constants (defined in SpanNames.h). `ledgerHash` and
/// `fullValidation` are shared with the consensus validation spans — same
/// concept, same key, told apart by span name.
/**
* Canonical shared constants (defined in SpanNames.h). `ledgerHash` and
* `fullValidation` are shared with the consensus validation spans — same
* concept, same key, told apart by span name.
*/
using ::xrpl::telemetry::attr::fullValidation;
using ::xrpl::telemetry::attr::ledgerHash;
using ::xrpl::telemetry::attr::peerId;
/// Trust flag qualified by message type, shared with consensus.*.receive.
/**
* Trust flag qualified by message type, shared with consensus.*.receive.
*/
inline constexpr auto proposalTrusted = makeStr("proposal_trusted");
inline constexpr auto validationTrusted = makeStr("validation_trusted");
} // namespace attr