Skip to content

Commit

Permalink
Add comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Kaplas80 committed May 8, 2021
1 parent d26e2c1 commit 905113a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
6 changes: 5 additions & 1 deletion src/Yarhl/FileSystem/Node.cs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,11 @@ public Node(string name, IFormat initialFormat)
/// </summary>
/// <param name="node">The original node.</param>
/// <remarks><para>It makes a copy of the original node.
/// The original format is deep copied. See <see cref="ICloneableFormat"/> for details.</para></remarks>
/// The original format is deep copied. See <see cref="ICloneableFormat"/> for details.</para>
/// </remarks>
/// <remarks><para>If the node has children, it must be a <see cref="NodeContainerFormat"/> to clone them.
/// In other case, the format must implement <see cref="ICloneableFormat"/> and clone the children explicitly.
/// </para></remarks>
public Node(Node node)
: this(node != null ? node.Name : string.Empty)
{
Expand Down
7 changes: 6 additions & 1 deletion src/Yarhl/IO/BinaryFormat.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,12 @@ public BinaryFormat(Stream stream, long offset, long length)
private set;
}

/// <inheritdoc />
/// <summary>
/// Makes a copy of the format stream <strong>into memory</strong>
/// and returns a new <see cref="BinaryFormat"/> object.
/// </summary>
/// <remarks><para>The stream is copied into memory, so it is limited to 2GB size.</para></remarks>
/// <returns>The cloned <see cref="BinaryFormat"/>.</returns>
public virtual object DeepClone()
{
DataStream newStream = DataStreamFactory.FromMemory();
Expand Down

0 comments on commit 905113a

Please sign in to comment.