aaru-dps/Aaru
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.git synced 2025-12-16 19:24:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve parameter documentation in interface files

Browse Source
This commit is contained in:
Natalia Portillo
2025-10-23 04:07:52 +01:00
parent 46baa53e62
commit 23873fb2f5
5 changed files with 45 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Aaru.CommonTypes/Interfaces/IReadOnlyFilesystem.cs
View File

@@ -70,8 +70,8 @@ public interface IReadOnlyFilesystem : IFilesystem
/// Initializes whatever internal structures the filesystem plugin needs to be able to read files and directories
/// from the filesystem.
/// </summary>
/// <param name="imagePlugin"></param>
/// <param name="partition"></param>
/// <param name="imagePlugin">The image plugin containing the filesystem.</param>
/// <param name="partition">The partition containing the filesystem.</param>
/// <param name="encoding">Which encoding to use for this filesystem.</param>
/// <param name="options">Dictionary of key=value pairs containing options to pass to the filesystem</param>
/// <param name="namespace">Filename namespace</param>
@@ -102,16 +102,19 @@ public interface IReadOnlyFilesystem : IFilesystem
/// <summary>Gets information about the mounted volume.</summary>
/// <param name="stat">Information about the mounted volume.</param>
/// <returns>Error number.</returns>
ErrorNumber StatFs(out FileSystemInfo stat);
/// <summary>Gets information about a file or directory.</summary>
/// <param name="path">File path.</param>
/// <param name="stat">File information.</param>
/// <returns>Error number.</returns>
ErrorNumber Stat(string path, out FileEntryInfo stat);
/// <summary>Solves a symbolic link.</summary>
/// <param name="path">Link path.</param>
/// <param name="dest">Link destination.</param>
/// <returns>Error number.</returns>
ErrorNumber ReadLink(string path, out string dest);
/// <summary>Opens a file for reading.</summary>
@@ -155,6 +158,7 @@ public interface IReadOnlyFilesystem : IFilesystem
/// <param name="length">Bytes to read.</param>
/// <param name="buffer">Buffer. Must exist and be of size equal or bigger than <see cref="length" /></param>
/// <param name="read">How many bytes were read into the buffer</param>
/// <returns>Error number.</returns>
ErrorNumber ReadFile(IFileNode node, long length, byte[] buffer, out long read);
/// <summary>Opens a directory for listing.</summary>