Skip to content

Commit 7b21b52

Browse files
committed
update api to use interface
1 parent 3a2f3b3 commit 7b21b52

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

src/EawModinfo/Utilities/ModIdentifierBuilder.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,13 @@ public enum ModLocationKind
3535
/// <summary>
3636
/// Creates a mod reference for a virtual mod from the specified modinfo data.
3737
/// </summary>
38+
/// <remarks>
39+
/// The identifier of the returned mod reference is created based on section III.2.4 of the modinfo specification.
40+
/// </remarks>
3841
/// <param name="modinfo">The modinfo data to create a virtual mod reference from.</param>
3942
/// <returns>A mod reference for a virtual mod.</returns>
4043
/// <exception cref="ArgumentNullException"><paramref name="modinfo"/> is <see langword="null"/>.</exception>
41-
public static IModReference CreateVirtualModIdentifier(ModinfoData modinfo)
44+
public static IModReference CreateVirtualModIdentifier(IModinfo modinfo)
4245
{
4346
if (modinfo == null)
4447
throw new ArgumentNullException(nameof(modinfo));
@@ -49,7 +52,7 @@ public static IModReference CreateVirtualModIdentifier(ModinfoData modinfo)
4952
/// Creates an enumerable collection of mod references from the specified <see cref="ModinfoFinderCollection"/>.
5053
/// </summary>
5154
/// <remarks>
52-
/// The mod references and their respective identifiers are created based on sections I.4 and III.2.4 from the modinfo specification.
55+
/// The mod references and their respective identifiers are created based on sections I.4 and III.2.4 of the modinfo specification.
5356
/// <br/>
5457
/// This method does not sanity check the collection's location against <paramref name="locationKind"/>,
5558
/// except that <see cref="ModLocationKind.SteamWorkshops"/> requires the directory name to be convertible into a Steam Workshops ID.

0 commit comments

Comments
 (0)