Inherit documentation.

This commit is contained in:
2020-07-20 05:20:18 +01:00
parent 9cfef45856
commit b52642af4e
14 changed files with 27 additions and 15 deletions

View File

@@ -1435,6 +1435,7 @@
</e>
<e p="Aaru.Images" t="IncludeRecursive">
<e p="Aaru.Images.csproj" t="IncludeRecursive" />
<e p="Aaru.Images.csproj.DotSettings" t="Include" />
<e p="AaruFormat" t="Include">
<e p="AaruFormat.cs" t="Include" />
<e p="CdEcc.cs" t="Include" />

View File

@@ -41,6 +41,7 @@ namespace Aaru.Filesystems.AppleDOS
{
public partial class AppleDOS
{
/// <inheritdoc />
/// <summary>Solves a symbolic link.</summary>
/// <param name="path">Link path.</param>
/// <param name="dest">Link destination.</param>
@@ -51,6 +52,7 @@ namespace Aaru.Filesystems.AppleDOS
return !mounted ? Errno.AccessDenied : Errno.NotSupported;
}
/// <inheritdoc />
/// <summary>Lists contents from a directory.</summary>
/// <param name="path">Directory path.</param>
/// <param name="contents">Directory contents.</param>

View File

@@ -44,6 +44,7 @@ namespace Aaru.Filesystems.AppleDOS
{
public partial class AppleDOS
{
/// <inheritdoc />
/// <summary>Mounts an Apple DOS filesystem</summary>
public Errno Mount(IMediaImage imagePlugin, Partition partition, Encoding encoding,
Dictionary<string, string> options, string @namespace)
@@ -127,6 +128,7 @@ namespace Aaru.Filesystems.AppleDOS
return Errno.NoError;
}
/// <inheritdoc />
/// <summary>Umounts this DOS filesystem</summary>
public Errno Unmount()
{
@@ -139,6 +141,7 @@ namespace Aaru.Filesystems.AppleDOS
return Errno.NoError;
}
/// <inheritdoc />
/// <summary>Gets information about the mounted volume.</summary>
/// <param name="stat">Information about the mounted volume.</param>
public Errno StatFs(out FileSystemInfo stat)

View File

@@ -38,6 +38,7 @@ namespace Aaru.Filesystems.AppleDOS
{
public partial class AppleDOS
{
/// <inheritdoc />
/// <summary>Lists all extended attributes, alternate data streams and forks of the given file.</summary>
/// <returns>Error number.</returns>
/// <param name="path">Path.</param>
@@ -81,6 +82,7 @@ namespace Aaru.Filesystems.AppleDOS
return Errno.NoError;
}
/// <inheritdoc />
/// <summary>Reads an extended attribute, alternate data stream or fork from the given file.</summary>
/// <returns>Error number.</returns>
/// <param name="path">File path.</param>

View File

@@ -794,6 +794,7 @@ namespace Aaru.Filesystems.CPM
return Errno.NoError;
}
/// <inheritdoc />
/// <summary>Gets information about the mounted volume.</summary>
/// <param name="stat">Information about the mounted volume.</param>
public Errno StatFs(out FileSystemInfo stat)

View File

@@ -38,6 +38,7 @@ namespace Aaru.Filesystems.CPM
{
internal partial class CPM
{
/// <inheritdoc />
/// <summary>Reads an extended attribute, alternate data stream or fork from the given file.</summary>
/// <returns>Error number.</returns>
/// <param name="path">File path.</param>
@@ -70,6 +71,7 @@ namespace Aaru.Filesystems.CPM
: Errno.NoSuchExtendedAttribute;
}
/// <inheritdoc />
/// <summary>Lists all extended attributes, alternate data streams and forks of the given file.</summary>
/// <returns>Error number.</returns>
/// <param name="path">Path.</param>

View File

@@ -42,6 +42,7 @@ namespace Aaru.Filesystems.FAT
{
public partial class FAT
{
/// <inheritdoc />
/// <summary>Solves a symbolic link.</summary>
/// <param name="path">Link path.</param>
/// <param name="dest">Link destination.</param>
@@ -52,6 +53,7 @@ namespace Aaru.Filesystems.FAT
return Errno.NotSupported;
}
/// <inheritdoc />
/// <summary>Lists contents from a directory.</summary>
/// <param name="path">Directory path.</param>
/// <param name="contents">Directory contents.</param>

View File

@@ -54,7 +54,7 @@ namespace Aaru.Filesystems.FAT
IMediaImage image;
/// <summary>Mounts an Apple Lisa filesystem</summary>
/// <inheritdoc />
public Errno Mount(IMediaImage imagePlugin, Partition partition, Encoding encoding,
Dictionary<string, string> options, string @namespace)
{
@@ -861,7 +861,7 @@ namespace Aaru.Filesystems.FAT
return Errno.NoError;
}
/// <summary>Umounts this Lisa filesystem</summary>
/// <inheritdoc />
public Errno Unmount()
{
if(!mounted)
@@ -873,8 +873,7 @@ namespace Aaru.Filesystems.FAT
return Errno.NoError;
}
/// <summary>Gets information about the mounted volume.</summary>
/// <param name="stat">Information about the mounted volume.</param>
/// <inheritdoc />
public Errno StatFs(out FileSystemInfo stat)
{
stat = null;

View File

@@ -44,10 +44,7 @@ namespace Aaru.Filesystems.FAT
{
Dictionary<string, Dictionary<string, byte[]>> eaCache;
/// <summary>Lists all extended attributes, alternate data streams and forks of the given file.</summary>
/// <returns>Error number.</returns>
/// <param name="path">Path.</param>
/// <param name="xattrs">List of extended attributes, alternate data streams and forks.</param>
/// <inheritdoc />
public Errno ListXAttr(string path, out List<string> xattrs)
{
xattrs = null;
@@ -102,11 +99,7 @@ namespace Aaru.Filesystems.FAT
return Errno.NoError;
}
/// <summary>Reads an extended attribute, alternate data stream or fork from the given file.</summary>
/// <returns>Error number.</returns>
/// <param name="path">File path.</param>
/// <param name="xattr">Extendad attribute, alternate data stream or fork name.</param>
/// <param name="buf">Buffer.</param>
/// <inheritdoc />
public Errno GetXattr(string path, string xattr, ref byte[] buf)
{
if(!mounted)

View File

@@ -41,6 +41,7 @@ namespace Aaru.Filesystems.LisaFS
{
public partial class LisaFS
{
/// <inheritdoc />
/// <summary>Solves a symbolic link.</summary>
/// <param name="path">Link path.</param>
/// <param name="dest">Link destination.</param>
@@ -52,6 +53,7 @@ namespace Aaru.Filesystems.LisaFS
return Errno.NotSupported;
}
/// <inheritdoc />
/// <summary>Lists contents from a directory.</summary>
/// <param name="path">Directory path.</param>
/// <param name="contents">Directory contents.</param>

View File

@@ -46,6 +46,7 @@ namespace Aaru.Filesystems.LisaFS
{
public partial class LisaFS
{
/// <inheritdoc />
/// <summary>Mounts an Apple Lisa filesystem</summary>
public Errno Mount(IMediaImage imagePlugin, Partition partition, Encoding encoding,
Dictionary<string, string> options, string @namespace)
@@ -357,6 +358,7 @@ namespace Aaru.Filesystems.LisaFS
}
}
/// <inheritdoc />
/// <summary>Umounts this Lisa filesystem</summary>
public Errno Unmount()
{
@@ -375,6 +377,7 @@ namespace Aaru.Filesystems.LisaFS
return Errno.NoError;
}
/// <inheritdoc />
/// <summary>Gets information about the mounted volume.</summary>
/// <param name="stat">Information about the mounted volume.</param>
public Errno StatFs(out FileSystemInfo stat)

View File

@@ -41,6 +41,7 @@ namespace Aaru.Filesystems.LisaFS
{
public partial class LisaFS
{
/// <inheritdoc />
/// <summary>Lists all extended attributes, alternate data streams and forks of the given file.</summary>
/// <returns>Error number.</returns>
/// <param name="path">Path.</param>
@@ -56,6 +57,7 @@ namespace Aaru.Filesystems.LisaFS
return isDir ? Errno.InvalidArgument : ListXAttr(fileId, out xattrs);
}
/// <inheritdoc />
/// <summary>Reads an extended attribute, alternate data stream or fork from the given file.</summary>
/// <returns>Error number.</returns>
/// <param name="path">File path.</param>