From 4f71fe0022cf38d5eb8a0bdcc8483ca956207356 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pawe=C5=82=20Bylica?= <chfast@gmail.com>
Date: Mon, 22 Jul 2019 12:36:32 +0200
Subject: [PATCH] tmp: Docs for basic types

---
 include/evmc/evmc.hpp | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/include/evmc/evmc.hpp b/include/evmc/evmc.hpp
index 255170f82..37a061928 100644
--- a/include/evmc/evmc.hpp
+++ b/include/evmc/evmc.hpp
@@ -15,13 +15,26 @@
 /// @ingroup cpp
 namespace evmc
 {
+
+/// The big-endian 160-bit hash suitable for keeping an Ethereum address.
+///
+/// This type wraps C ::evmc_address to make sure objects of this type are always initialized.
 struct address : evmc_address
 {
+    /// Default and converting constructor.
+    ///
+    /// Initializes bytes to zeros if not other @p init value provided.
     constexpr address(evmc_address init = {}) noexcept : evmc_address{init} {}
 };
 
+/// The fixed size array of 32 bytes for storing 256-bit EVM values.
+///
+/// This type wraps C ::evmc_bytes32 to make sure objects of this type are always initialized.
 struct bytes32 : evmc_bytes32
 {
+    /// Default and converting constructor.
+    ///
+    /// Initializes bytes to zeros if not other @p init value provided.
     constexpr bytes32(evmc_bytes32 init = {}) noexcept : evmc_bytes32{init} {}
 };