Add more xmldoc

This commit is contained in:
Kurt 2021-06-06 11:56:54 -07:00
parent bad65dd4ec
commit 871de4e213
9 changed files with 39 additions and 1 deletions

View file

@ -1,5 +1,8 @@
namespace PKHeX.Core
{
/// <summary>
/// Interface containing details relevant for battling.
/// </summary>
public interface IBattleTemplate : ISpeciesForm, IGigantamax, INature
{
/// <summary>

View file

@ -4,6 +4,12 @@ using System.Linq;
namespace PKHeX.Core
{
/// <summary>
/// Localizing Memory strings
/// </summary>
/// <remarks>
/// <see cref="IMemoryOT"/> and <see cref="IMemoryHT"/> parameters build strings.
/// </remarks>
public sealed class MemoryStrings
{
private readonly GameStrings s;

View file

@ -4,6 +4,9 @@ using static PKHeX.Core.GameVersion;
namespace PKHeX.Core
{
/// <summary>
/// Cached copies of Met Location lists
/// </summary>
public sealed class MetDataSource
{
private readonly List<ComboItem> MetGen2;

View file

@ -2,6 +2,10 @@
namespace PKHeX.Core
{
/// <summary>
/// Generation 3 <see cref="SaveFile"/> object for <see cref="GameVersion.E"/>.
/// </summary>
/// <inheritdoc cref="SAV3" />
public sealed class SAV3E : SAV3, IGen3Hoenn, IGen3Joyful, IGen3Wonder
{
// Configuration

View file

@ -2,6 +2,10 @@
namespace PKHeX.Core
{
/// <summary>
/// Generation 5 <see cref="SaveFile"/> object for <see cref="GameVersion.FRLG"/>.
/// </summary>
/// <inheritdoc cref="SAV3" />
public sealed class SAV3FRLG : SAV3, IGen3Joyful, IGen3Wonder
{
// Configuration

View file

@ -2,6 +2,10 @@
namespace PKHeX.Core
{
/// <summary>
/// Generation 3 <see cref="SaveFile"/> object for <see cref="GameVersion.RS"/>.
/// </summary>
/// <inheritdoc cref="SAV3" />
public sealed class SAV3RS : SAV3, IGen3Hoenn
{
// Configuration

View file

@ -2,6 +2,10 @@
namespace PKHeX.Core
{
/// <summary>
/// Generation 5 <see cref="SaveFile"/> object for <see cref="GameVersion.B2W2"/>.
/// </summary>
/// <inheritdoc cref="SAV5" />
public sealed class SAV5B2W2 : SAV5, ISaveBlock5B2W2
{
public SAV5B2W2() : base(SaveUtil.SIZE_G5RAW)

View file

@ -2,6 +2,10 @@
namespace PKHeX.Core
{
/// <summary>
/// Generation 5 <see cref="SaveFile"/> object for <see cref="GameVersion.BW"/>.
/// </summary>
/// <inheritdoc cref="SAV5" />
public sealed class SAV5BW : SAV5
{
public SAV5BW() : base(SaveUtil.SIZE_G5RAW)

View file

@ -28,16 +28,22 @@ namespace PKHeX.Core
protected readonly int BlockInfoOffset;
/// <summary>
/// Timestamp that the save file was last saved at (Secure Value)
/// </summary>
public ulong TimeStampCurrent
{
get => BitConverter.ToUInt64(Data, BlockInfoOffset);
set => BitConverter.GetBytes(value).CopyTo(Data, BlockInfoOffset);
}
/// <summary>
/// Timestamp that the save file was saved at prior to the <see cref="TimeStampCurrent"/> (Secure Value)
/// </summary>
public ulong TimeStampPrevious
{
get => BitConverter.ToUInt64(Data, BlockInfoOffset);
set => BitConverter.GetBytes(value).CopyTo(Data, BlockInfoOffset);
}
}
}
}