C# Class Nexus.Client.Mods.Readme

Describes the readme file of a mod.
Inheritance: ObservableObject
Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method Description
IsValidExtension ( string p_strExtension ) : bool

Determines if the given extension is a valid readme extension.
IsValidFilename ( string p_strFilename ) : bool

Determines if the given filename is a valid readme file.
IsValidReadme ( string p_strPath ) : bool

Determines if the specified readme file is of a recognized format.
Readme ( ReadmeFormat p_fmtFormat, string p_strText ) : System

A simple constructor that initializes the object with the given values.
Readme ( string p_strPath, string p_strText ) : System

A simple constructor that initializes the object with the given values.

Method Details

IsValidExtension() public static method

Determines if the given extension is a valid readme extension.
public static IsValidExtension ( string p_strExtension ) : bool
p_strExtension string The extension whose validity is to be determined.
return bool

IsValidFilename() public static method

Determines if the given filename is a valid readme file.
public static IsValidFilename ( string p_strFilename ) : bool
p_strFilename string
return bool

IsValidReadme() public static method

Determines if the specified readme file is of a recognized format.
public static IsValidReadme ( string p_strPath ) : bool
p_strPath string The path of the readme file.
return bool

Readme() public method

A simple constructor that initializes the object with the given values.
public Readme ( ReadmeFormat p_fmtFormat, string p_strText ) : System
p_fmtFormat ReadmeFormat The readme format.
p_strText string The readme text.
return System

Readme() public method

A simple constructor that initializes the object with the given values.
public Readme ( string p_strPath, string p_strText ) : System
p_strPath string The path of the readme file. This is used to determine the .
p_strText string The readme text.
return System