Skip to content

Commit ccdcf09

Browse files
committed
Added documentation for 'Create' method.
1 parent ac76a71 commit ccdcf09

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

LibIPS.NET/LibIpsNet.cs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,17 +132,39 @@ public IpsError ApplyStudy(Stream patch, IpsStudy study, Stream inFile, Stream o
132132
// It is also known that I win in some other situations. I didn't bother checking which, though.
133133

134134
// There are no known cases where LIPS wins over libips.
135+
136+
/// <summary>
137+
/// Creates an IPS patch file from a source file path and a target file path.
138+
/// </summary>
139+
/// <param name="source">The source file that contains the original data.</param>
140+
/// <param name="target">The target file that contains the modified data.</param>
141+
/// <param name="patch">The patch file to contain the resulting patch data.</param>
142+
/// <returns></returns>
135143
public IpsError Create(string source, string target, string patch)
136144
{
137145
using (FileStream sourceStream = new FileStream(source, FileMode.Open), targetStream = new FileStream(target, FileMode.Open), patchStream = new FileStream(patch, FileMode.Create))
138146
{
139147
return Create(sourceStream, targetStream, patchStream);
140148
}
141149
}
150+
/// <summary>
151+
/// Creates an IPS patch file stream from a source file stream and a target file stream.
152+
/// </summary>
153+
/// <param name="source">The source stream that contains the original data.</param>
154+
/// <param name="target">The target stream that contains the modified data.</param>
155+
/// <param name="patch">The patch file stream to contain the resulting patch data.</param>
156+
/// <returns></returns>
142157
public IpsError Create(FileStream source, FileStream target, FileStream patch)
143158
{
144159
return Create(source, target, patch);
145160
}
161+
/// <summary>
162+
/// Creates an IPS patch stream from a source stream and a target stream.
163+
/// </summary>
164+
/// <param name="source">The source stream that contains the original data.</param>
165+
/// <param name="target">The target stream that contains the modified data.</param>
166+
/// <param name="patch">The patch stream to contain the resulting patch data.</param>
167+
/// <returns></returns>
146168
public IpsError Create(Stream source, Stream target, ref Stream patch)
147169
{
148170
long sourcelen = source.Length;

0 commit comments

Comments
 (0)