Updates ModID property to ModGuid (#480)
* Updates `ModID` property to `ModGuid` This will better align with what it's referred to elsewhere. * Updated `ModGuid` Docblock Updated the `ModGuid` docblock to reference the ideal use of reverse domain name notation. * Updated `summary` to use `see` tag for reference link * Updated `summary` to include line break * Updated `summary` to include HTML line break
This commit is contained in:
@@ -8,9 +8,12 @@
|
||||
public abstract record AbstractModMetadata
|
||||
{
|
||||
/// <summary>
|
||||
/// A unique ID value for the mod to distinguish it from others
|
||||
/// A Global Unique ID (GUID) to distinguish this mod from all others.
|
||||
/// <br />
|
||||
/// It is recommended (but not mandatory) to use
|
||||
/// <see href="https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html">reverse domain name notation</see>.
|
||||
/// </summary>
|
||||
public abstract string ModId { get; set; }
|
||||
public abstract string ModGuid { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Name of this mod
|
||||
|
||||
Reference in New Issue
Block a user