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,6 +41,7 @@ namespace Aaru.Filesystems.UCSDPascal
// Information from Call-A.P.P.L.E. Pascal Disk Directory Structure
public sealed partial class PascalPlugin
{
/// <inheritdoc />
public Errno ReadDir(string path, out List<string> contents)
{
contents = null;

View File

@@ -40,6 +40,7 @@ namespace Aaru.Filesystems.UCSDPascal
// Information from Call-A.P.P.L.E. Pascal Disk Directory Structure
public sealed partial class PascalPlugin
{
/// <inheritdoc />
public Errno MapBlock(string path, long fileBlock, out long deviceBlock)
{
deviceBlock = 0;
@@ -47,6 +48,7 @@ namespace Aaru.Filesystems.UCSDPascal
return !_mounted ? Errno.AccessDenied : Errno.NotImplemented;
}
/// <inheritdoc />
public Errno GetAttributes(string path, out FileAttributes attributes)
{
attributes = new FileAttributes();
@@ -72,6 +74,7 @@ namespace Aaru.Filesystems.UCSDPascal
return error;
}
/// <inheritdoc />
public Errno Read(string path, long offset, long size, ref byte[] buf)
{
if(!_mounted)
@@ -119,6 +122,7 @@ namespace Aaru.Filesystems.UCSDPascal
return Errno.NoError;
}
/// <inheritdoc />
public Errno Stat(string path, out FileEntryInfo stat)
{
stat = null;

View File

@@ -45,6 +45,7 @@ namespace Aaru.Filesystems.UCSDPascal
// Information from Call-A.P.P.L.E. Pascal Disk Directory Structure
public sealed partial class PascalPlugin
{
/// <inheritdoc />
public bool Identify(IMediaImage imagePlugin, Partition partition)
{
if(partition.Length < 3)
@@ -112,6 +113,7 @@ namespace Aaru.Filesystems.UCSDPascal
return volEntry.Files >= 0;
}
/// <inheritdoc />
public void GetInformation(IMediaImage imagePlugin, Partition partition, out string information,
Encoding encoding)
{

View File

@@ -45,6 +45,7 @@ namespace Aaru.Filesystems.UCSDPascal
// Information from Call-A.P.P.L.E. Pascal Disk Directory Structure
public sealed partial class PascalPlugin
{
/// <inheritdoc />
public Errno Mount(IMediaImage imagePlugin, Partition partition, Encoding encoding,
Dictionary<string, string> options, string @namespace)
{
@@ -138,6 +139,7 @@ namespace Aaru.Filesystems.UCSDPascal
return Errno.NoError;
}
/// <inheritdoc />
public Errno Unmount()
{
_mounted = false;
@@ -146,6 +148,7 @@ namespace Aaru.Filesystems.UCSDPascal
return Errno.NoError;
}
/// <inheritdoc />
public Errno StatFs(out FileSystemInfo stat)
{
stat = new FileSystemInfo

View File

@@ -40,6 +40,9 @@ using Schemas;
namespace Aaru.Filesystems.UCSDPascal
{
// Information from Call-A.P.P.L.E. Pascal Disk Directory Structure
/// <summary>
/// Implements the U.C.S.D. Pascal filesystem
/// </summary>
public sealed partial class PascalPlugin : IReadOnlyFilesystem
{
byte[] _bootBlocks;
@@ -52,12 +55,18 @@ namespace Aaru.Filesystems.UCSDPascal
/// <summary>Apple II disks use 256 bytes / sector, but filesystem assumes it's 512 bytes / sector</summary>
uint _multiplier;
/// <inheritdoc />
public FileSystemType XmlFsType { get; private set; }
/// <inheritdoc />
public string Name => "U.C.S.D. Pascal filesystem";
/// <inheritdoc />
public Guid Id => new Guid("B0AC2CB5-72AA-473A-9200-270B5A2C2D53");
/// <inheritdoc />
public Encoding Encoding { get; private set; }
/// <inheritdoc />
public string Author => "Natalia Portillo";
/// <inheritdoc />
public Errno ListXAttr(string path, out List<string> xattrs)
{
xattrs = null;
@@ -65,8 +74,10 @@ namespace Aaru.Filesystems.UCSDPascal
return Errno.NotSupported;
}
/// <inheritdoc />
public Errno GetXattr(string path, string xattr, ref byte[] buf) => Errno.NotSupported;
/// <inheritdoc />
public Errno ReadLink(string path, out string dest)
{
dest = null;
@@ -74,10 +85,12 @@ namespace Aaru.Filesystems.UCSDPascal
return Errno.NotSupported;
}
/// <inheritdoc />
public IEnumerable<(string name, Type type, string description)> SupportedOptions =>
new (string name, Type type, string description)[]
{};
/// <inheritdoc />
public Dictionary<string, string> Namespaces => null;
static Dictionary<string, string> GetDefaultOptions() => new Dictionary<string, string>