Skip to content
This repository was archived by the owner on Oct 28, 2021. It is now read-only.

Commit d424f0e

Browse files
committed
Triple slashes in comments in ENR.h
1 parent 242fd6c commit d424f0e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

libp2p/ENR.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ class ENR
2424
// ENR class implementation is independent of Identity Scheme.
2525
// Identity Scheme specifics are passed to ENR as functions.
2626

27-
// Sign function gets serialized ENR contents and signs it according to some Identity Scheme
27+
/// Sign function gets serialized ENR contents and signs it according to some Identity Scheme
2828
using SignFunction = std::function<bytes(bytesConstRef)>;
29-
// Verify function gets ENR key-value pairs, signature, and serialized content and validates the
30-
// signature according to some Identity Scheme
29+
/// Verify function gets ENR key-value pairs, signature, and serialized content and validates the
30+
/// signature according to some Identity Scheme
3131
using VerifyFunction =
3232
std::function<bool(std::map<std::string, bytes> const&, bytesConstRef, bytesConstRef)>;
3333

34-
// Parse from RLP with given signature verification function
34+
/// Parse from RLP with given signature verification function
3535
ENR(RLP const& _rlp, VerifyFunction const& _verifyFunction);
36-
// Create with given sign function
36+
/// Create with given sign function
3737
ENR(uint64_t _seq, std::map<std::string, bytes> const& _keyValuePairs,
3838
SignFunction const& _signFunction);
3939

@@ -42,16 +42,16 @@ class ENR
4242

4343
std::map<std::string, bytes> const& keyValuePairs() const { return m_keyValuePairs; }
4444

45-
// Pre-defined keys
45+
/// Pre-defined keys
4646
std::string id() const;
4747
boost::asio::ip::address ip() const;
4848
uint16_t tcpPort() const;
4949
uint16_t udpPort() const;
5050

51-
// Serialize to given RLP stream
51+
/// Serialize to given RLP stream
5252
void streamRLP(RLPStream& _s) const;
5353

54-
// Create new ENR succeeding current one with updated keyValuePairs
54+
/// Create new ENR succeeding current one with updated @a _keyValuePairs
5555
ENR update(
5656
std::map<std::string, bytes> const& _keyValuePair, SignFunction const& _signFunction) const;
5757

0 commit comments

Comments
 (0)