Skip to content

Commit

Permalink
Fixed missing XML documentation in NuGet package.
Browse files Browse the repository at this point in the history
  • Loading branch information
MaikelChan committed Sep 6, 2021
1 parent e0f3fac commit 93b2374
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 3 deletions.
9 changes: 9 additions & 0 deletions AFSLib/AFS.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@

namespace AFSLib
{
/// <summary>
/// Class that represents one AFS archive. It can be created from scratch or loaded from a file or stream.
/// </summary>
public class AFS : IDisposable
{
/// <summary>
Expand Down Expand Up @@ -44,6 +47,12 @@ public class AFS : IDisposable
/// Event that will be called each time some process wants to report something.
/// </summary>
public event NotifyProgressDelegate NotifyProgress;

/// <summary>
/// Represents the method that will handle the NotifyProgress event.
/// </summary>
/// <param name="type">Type of notification.</param>
/// <param name="message">The notification message.</param>
public delegate void NotifyProgressDelegate(NotificationType type, string message);

internal const uint HEADER_MAGIC_00 = 0x00534641; // AFS
Expand Down
7 changes: 4 additions & 3 deletions AFSLib/AFSLib.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<Authors>MaikelChan</Authors>
<Description>AFSLib is a library that can extract, create and manipulate AFS files. The AFS format is used in many games from companies like Sega.</Description>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<FileVersion>2.0.0.0</FileVersion>
<Version>2.0.0</Version>
<AssemblyVersion>2.0.1.0</AssemblyVersion>
<FileVersion>2.0.1.0</FileVersion>
<Version>2.0.1</Version>
<Company />
<PackageProjectUrl>https://github.com/MaikelChan/AFSLib</PackageProjectUrl>
<RepositoryUrl>https://github.com/MaikelChan/AFSLib</RepositoryUrl>
Expand Down
3 changes: 3 additions & 0 deletions AFSLib/AttributesInfoType.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@

namespace AFSLib
{
/// <summary>
/// Enumeration that contains all possible attribute info locations in an AFS archive.
/// </summary>
public enum AttributesInfoType
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions AFSLib/DataEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace AFSLib
{
/// <summary>
/// Abstract class that represents an entry with data.
/// </summary>
public abstract class DataEntry : Entry
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions AFSLib/Entry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace AFSLib
{
/// <summary>
/// Abstract class that represents an entry. All types of entries derive from Entry.
/// </summary>
public abstract class Entry
{
internal abstract Stream GetStream();
Expand Down
3 changes: 3 additions & 0 deletions AFSLib/FileEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace AFSLib
{
/// <summary>
/// Class that represents an entry with data referenced from a file.
/// </summary>
public sealed class FileEntry : DataEntry
{
private readonly FileInfo fileInfo;
Expand Down
3 changes: 3 additions & 0 deletions AFSLib/HeaderMagicType.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@

namespace AFSLib
{
/// <summary>
/// Enumeration containing each type of header magic that can be found in an AFS archive.
/// </summary>
public enum HeaderMagicType
{
/// <summary>
Expand Down
19 changes: 19 additions & 0 deletions AFSLib/NotificationType.cs
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@

namespace AFSLib
{
/// <summary>
/// Enumeration containing all types of notifications.
/// </summary>
public enum NotificationType
{
/// <summary>
/// Notification considered as Information.
/// </summary>
Info,

/// <summary>
/// Notification considered as Warning.
/// </summary>
Warning,

/// <summary>
/// Notification considered as Error.
/// </summary>
Error,

/// <summary>
/// Notification considered as Success.
/// </summary>
Success
}
}
3 changes: 3 additions & 0 deletions AFSLib/NullEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace AFSLib
{
/// <summary>
/// Class that represents an empty entry with no data.
/// </summary>
public class NullEntry : Entry
{
internal NullEntry()
Expand Down
3 changes: 3 additions & 0 deletions AFSLib/StreamEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace AFSLib
{
/// <summary>
/// Class that represents an entry with data referenced from a stream.
/// </summary>
public sealed class StreamEntry : DataEntry
{
private readonly Stream baseStream;
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [2.0.1] - 2021-09-06
### Fixed
- Fixed missing XML documentation in NuGet package.

## [2.0.0] - 2021-09-06
### Added
- Entry block alignment is now configurable.
Expand Down

0 comments on commit 93b2374

Please sign in to comment.