Skip to content

Commit f0f6fea

Browse files
docs(BlockInfo): describe the BlockInfo
1 parent b6b15dd commit f0f6fea

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/CoreApi/BlockApi.cs

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,27 @@ namespace Ipfs.Api
99
{
1010

1111
/// <summary>
12-
///
12+
/// Information about a raw IPFS Block.
1313
/// </summary>
14+
/// <seealso cref="BlockApi.StatAsync"/>
1415
public class BlockInfo
1516
{
1617
/// <summary>
17-
/// TODO
18+
/// The unique ID of the block.
1819
/// </summary>
20+
/// <value>
21+
/// Typically, the string representation of a <see cref="MultiHash"/>.
22+
/// </value>
1923
public string Key { get; set; }
2024

2125
/// <summary>
22-
/// TODO
26+
/// The serialised size (in bytes) of the block.
2327
/// </summary>
2428
public long Size { get; set; }
2529
}
2630

2731
/// <summary>
28-
/// Manages raw <see cref="Block">IPFS blocks</see>.
32+
/// Manages the raw <see cref="Block">IPFS blocks</see>.
2933
/// </summary>
3034
/// <remarks>
3135
/// An IPFS Block is a byte sequence that represents an IPFS Object

0 commit comments

Comments
 (0)