Add XML comments to public entities.

This commit is contained in:
2021-08-17 13:56:05 +01:00
parent 0d18153610
commit 00f605b0ca
542 changed files with 6029 additions and 104 deletions

View File

@@ -41,16 +41,25 @@ using Schemas;
namespace Aaru.Filesystems
{
// Information from the Linux kernel
/// <summary>
/// Implements detection of the UNIX boot filesystem
/// </summary>
public sealed class BFS : IFilesystem
{
const uint BFS_MAGIC = 0x1BADFACE;
/// <inheritdoc />
public FileSystemType XmlFsType { get; private set; }
/// <inheritdoc />
public Encoding Encoding { get; private set; }
/// <inheritdoc />
public string Name => "UNIX Boot filesystem";
/// <inheritdoc />
public Guid Id => new Guid("1E6E0DA6-F7E4-494C-80C6-CB5929E96155");
/// <inheritdoc />
public string Author => "Natalia Portillo";
/// <inheritdoc />
public bool Identify(IMediaImage imagePlugin, Partition partition)
{
if(2 + partition.Start >= partition.End)
@@ -61,6 +70,7 @@ namespace Aaru.Filesystems
return magic == BFS_MAGIC;
}
/// <inheritdoc />
public void GetInformation(IMediaImage imagePlugin, Partition partition, out string information,
Encoding encoding)
{