doc: added doc

planetarium · Jun 3, 2021 · eb41d05 · eb41d05
1 parent 102f695
commit eb41d05
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 1 deletion.
diff --git a/Libplanet.RocksDBStore/MonoRocksDBStore.cs b/Libplanet.RocksDBStore/MonoRocksDBStore.cs
@@ -544,6 +544,7 @@ public override TxExecution GetTxExecution(BlockHash blockHash, TxId txid)
             return null;
         }
 
+        /// <inheritdoc cref="BaseStore.PutTxIdBlockHashIndex(Guid, TxId, BlockHash)"/>
         public override void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash blockHash)
         {
             var cf = GetColumnFamily(_chainDb, chainId);
@@ -554,6 +555,7 @@ public override void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash bl
                 );
         }
 
+        /// <inheritdoc cref="BaseStore.GetTxIdBlockHashIndex(Guid, TxId)"/>
         public override BlockHash? GetTxIdBlockHashIndex(Guid chainId, TxId txId)
         {
             var cf = GetColumnFamily(_chainDb, chainId);
@@ -565,6 +567,7 @@ public override void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash bl
             return new BlockHash(blockHashByte);
         }
 
+        /// <inheritdoc cref="BaseStore.DeleteTxIdBlockHashIndex(Guid, TxId)"/>
         public override void DeleteTxIdBlockHashIndex(Guid chainId, TxId txId)
         {
             var cf = GetColumnFamily(_chainDb, chainId);

diff --git a/Libplanet.RocksDBStore/RocksDBStore.cs b/Libplanet.RocksDBStore/RocksDBStore.cs
@@ -760,6 +760,7 @@ public override bool ContainsBlock(BlockHash blockHash)
             return false;
         }
 
+        /// <inheritdoc cref="BaseStore.PutTxIdBlockHashIndex(Guid, TxId, BlockHash)"/>
         public override void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash blockHash)
         {
             var cf = GetColumnFamily(_chainDb, chainId);
@@ -770,6 +771,7 @@ public override void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash bl
                 );
         }
 
+        /// <inheritdoc cref="BaseStore.GetTxIdBlockHashIndex(Guid, TxId)"/>
         public override BlockHash? GetTxIdBlockHashIndex(Guid chainId, TxId txId)
         {
             var cf = GetColumnFamily(_chainDb, chainId);
@@ -781,6 +783,7 @@ public override void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash bl
             return new BlockHash(blockHashByte);
         }
 
+        /// <inheritdoc cref="BaseStore.DeleteTxIdBlockHashIndex(Guid, TxId)"/>
         public override void DeleteTxIdBlockHashIndex(Guid chainId, TxId txId)
         {
             var cf = GetColumnFamily(_chainDb, chainId);

diff --git a/Libplanet/Store/BaseStore.cs b/Libplanet/Store/BaseStore.cs
@@ -141,14 +141,17 @@ public abstract void PutBlock<T>(Block<T> block)
         /// <inheritdoc cref="IStore.PutTxIdBlockHashIndex(Guid, TxId, BlockHash)"/>
         public abstract void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash blockHash);
 
+        /// <inheritdoc cref="IStore.HasTxIdBlockHashIndex(Guid, TxId)"/>
         public bool HasTxIdBlockHashIndex(Guid chainId, TxId txId)
         {
             return GetTxIdBlockHashIndex(chainId, txId) != null;
         }
 
+        /// <inheritdoc cref="IStore.DeleteTxIdBlockHashIndex(Guid, TxId)"/>
         public abstract BlockHash? GetTxIdBlockHashIndex(
             Guid chainId, TxId txId);
 
+        /// <inheritdoc cref="IStore.DeleteTxIdBlockHashIndex(Guid, TxId)"/>
         public abstract void DeleteTxIdBlockHashIndex(Guid chainId, TxId txId);
 
         /// <inheritdoc cref="IStore.SetBlockPerceivedTime(BlockHash, DateTimeOffset)"/>

diff --git a/Libplanet/Store/DefaultStore.cs b/Libplanet/Store/DefaultStore.cs
@@ -546,6 +546,7 @@ public override TxExecution GetTxExecution(BlockHash blockHash, TxId txid)
             return null;
         }
 
+        /// <inheritdoc cref="BaseStore.PutTxIdBlockHashIndex(Guid, TxId, BlockHash)"/>
         public override void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash blockHash)
         {
             var collection = TxIdBlockIndexCollection(chainId);
@@ -573,13 +574,15 @@ public override void PutTxIdBlockHashIndex(Guid chainId, TxId txId, BlockHash bl
             }
         }
 
+        /// <inheritdoc cref="BaseStore.GetTxIdBlockHashIndex(Guid, TxId)"/>
         public override BlockHash? GetTxIdBlockHashIndex(Guid chainId, TxId txId)
         {
             var doc = TxIdBlockIndexCollection(chainId)
                 .FindOne(Query.EQ("TxId", new BsonValue(txId.ToByteArray())));
             return doc is { } d ? d.BlockHash : (BlockHash?)null;
         }
 
+        /// <inheritdoc cref="BaseStore.DeleteTxIdBlockHashIndex(Guid, TxId)"/>
         public override void DeleteTxIdBlockHashIndex(Guid chainId, TxId txId)
         {
             TxIdBlockIndexCollection(chainId)

diff --git a/Libplanet/Store/IStore.cs b/Libplanet/Store/IStore.cs
@@ -232,7 +232,6 @@ void PutBlock<T>(Block<T> block)
         TxExecution GetTxExecution(BlockHash blockHash, TxId txid);
 
         /// <summary>
-        /// MARSHALL JANGJANG
         /// Records a index for given pair <paramref name="txId"/> and <paramref name="blockHash"/>.
         /// </summary>
         /// <param name="chainId">The chain ID of the index.</param>