From df4431300293ef5aa2201b4abfa921c8124e542f Mon Sep 17 00:00:00 2001 From: sbaeumlisberger Date: Mon, 28 Oct 2024 20:28:03 +0100 Subject: [PATCH] improve api doc --- WindowsRecylceBin/IRecycleBin.cs | 4 +++ WindowsRecylceBin/RecycleBin.cs | 4 +++ WindowsRecylceBin/RecycleBinEntry.cs | 1 + docs/api/WindowsRecylceBin.IRecycleBin.html | 22 +++++++++------- docs/api/WindowsRecylceBin.RecycleBin.html | 26 ++++++++++--------- .../WindowsRecylceBin.RecycleBinEntry.html | 22 +++++++++------- docs/api/WindowsRecylceBin.html | 11 +++++--- 7 files changed, 55 insertions(+), 35 deletions(-) diff --git a/WindowsRecylceBin/IRecycleBin.cs b/WindowsRecylceBin/IRecycleBin.cs index 4d87101..e0e3155 100644 --- a/WindowsRecylceBin/IRecycleBin.cs +++ b/WindowsRecylceBin/IRecycleBin.cs @@ -3,6 +3,10 @@ namespace WindowsRecylceBin; +/// +/// Provides access to the Windows recycle bin and allows to restore deleted files. +/// To create an instance of this interface, use the static methods RecycleBin.ForCurrentUser() or RecycleBin.For(SecurityIdentifier sid). +/// public interface IRecycleBin { /// diff --git a/WindowsRecylceBin/RecycleBin.cs b/WindowsRecylceBin/RecycleBin.cs index fb25fc2..52b575b 100644 --- a/WindowsRecylceBin/RecycleBin.cs +++ b/WindowsRecylceBin/RecycleBin.cs @@ -7,6 +7,10 @@ namespace WindowsRecylceBin; +/// +/// Provides access to the Windows recycle bin and allows to restore deleted files. +/// To create an instance of this class, use the static methods RecycleBin.ForCurrentUser() or RecycleBin.For(SecurityIdentifier sid). +/// public class RecycleBin : IRecycleBin { private const string MetadataFilePrefix = "$I"; diff --git a/WindowsRecylceBin/RecycleBinEntry.cs b/WindowsRecylceBin/RecycleBinEntry.cs index f9b48a2..700f803 100644 --- a/WindowsRecylceBin/RecycleBinEntry.cs +++ b/WindowsRecylceBin/RecycleBinEntry.cs @@ -2,6 +2,7 @@ namespace WindowsRecylceBin; +/// Represents an entry of the Windows recycle bin. /// The original file path. /// The timestap when the file was deleted. /// The path of the metadata file in the recycle bin. diff --git a/docs/api/WindowsRecylceBin.IRecycleBin.html b/docs/api/WindowsRecylceBin.IRecycleBin.html index 92b5437..fbee222 100644 --- a/docs/api/WindowsRecylceBin.IRecycleBin.html +++ b/docs/api/WindowsRecylceBin.IRecycleBin.html @@ -6,7 +6,7 @@ - + @@ -85,7 +85,7 @@
Table of Contents

-Interface IRecycleBin +Interface IRecycleBin

@@ -93,7 +93,9 @@

Assembly
WindowsRecylceBin.dll

-
+

Provides access to the Windows recycle bin and allows to restore deleted files. +To create an instance of this interface, use the static methods RecycleBin.ForCurrentUser() or RecycleBin.For(SecurityIdentifier sid).

+
@@ -120,7 +122,7 @@

Methods

DeletePernamently(RecycleBinEntry) - +

Deletes the specified recycle bin entry pernamently.

@@ -153,7 +155,7 @@

Parameters

Empty() - +

Empties the recycle bin. This will delete all entries pernamently.

@@ -180,7 +182,7 @@

EnumerateEntries() - +

Enumerates all entries in the recycle bin.

@@ -212,7 +214,7 @@

Returns

GetEntries() - +

Gets all entries in the recycle bin.

@@ -244,7 +246,7 @@

Returns

Restore(string) - +

Restores the specified file or directory. If more than one matching entry is found, the entry with the most recent deletion time is restored.

@@ -283,7 +285,7 @@

Exceptions

Restore(RecycleBinEntry) - +

Restores the specified recycle bin entry.

@@ -316,7 +318,7 @@

Parameters

diff --git a/docs/api/WindowsRecylceBin.RecycleBin.html b/docs/api/WindowsRecylceBin.RecycleBin.html index 776b878..f97e7b0 100644 --- a/docs/api/WindowsRecylceBin.RecycleBin.html +++ b/docs/api/WindowsRecylceBin.RecycleBin.html @@ -6,7 +6,7 @@ - + @@ -85,7 +85,7 @@
Table of Contents

-Class RecycleBin +Class RecycleBin

@@ -93,7 +93,9 @@

Assembly
WindowsRecylceBin.dll

-
+

Provides access to the Windows recycle bin and allows to restore deleted files. +To create an instance of this class, use the static methods RecycleBin.ForCurrentUser() or RecycleBin.For(SecurityIdentifier sid).

+
@@ -158,7 +160,7 @@

Methods

DeletePernamently(RecycleBinEntry) - +

Deletes the specified recycle bin entry pernamently.

@@ -191,7 +193,7 @@

Parameters

Empty() - +

Empties the recycle bin. This will delete all entries pernamently.

@@ -218,7 +220,7 @@

EnumerateEntries() - +

Enumerates all entries in the recycle bin.

@@ -250,7 +252,7 @@

Returns

For(SecurityIdentifier) - +

Gets the recycle bin for the specified SID.

@@ -287,7 +289,7 @@

Returns

ForCurrentUser() - +

Gets the recycle bin for the current user.

@@ -319,7 +321,7 @@

Returns

GetEntries() - +

Gets all entries in the recycle bin.

@@ -351,7 +353,7 @@

Returns

Restore(string) - +

Restores the specified file or directory. If more than one matching entry is found, the entry with the most recent deletion time is restored.

@@ -389,7 +391,7 @@

Exceptions

Restore(RecycleBinEntry) - +

Restores the specified recycle bin entry.

@@ -422,7 +424,7 @@

Parameters

diff --git a/docs/api/WindowsRecylceBin.RecycleBinEntry.html b/docs/api/WindowsRecylceBin.RecycleBinEntry.html index f0b10c1..2f3306f 100644 --- a/docs/api/WindowsRecylceBin.RecycleBinEntry.html +++ b/docs/api/WindowsRecylceBin.RecycleBinEntry.html @@ -6,7 +6,7 @@ - + @@ -85,7 +85,7 @@
Table of Contents

-Class RecycleBinEntry +Class RecycleBinEntry

@@ -93,7 +93,8 @@

+

Represents an entry of the Windows recycle bin.

+
@@ -158,10 +159,11 @@

Constructors

RecycleBinEntry(string, DateTime, string, string) - +

-
+

Represents an entry of the Windows recycle bin.

+
@@ -203,7 +205,7 @@

Properties

BackupFilePath - +

The path of the backup file in the recycle bin.

@@ -235,7 +237,7 @@

Property Value

DeletedAt - +

The timestap when the file was deleted.

@@ -267,7 +269,7 @@

Property Value

MetadataFilePath - +

The path of the metadata file in the recycle bin.

@@ -299,7 +301,7 @@

Property Value

OriginalFilePath - +

The original file path.

@@ -331,7 +333,7 @@

Property Value

diff --git a/docs/api/WindowsRecylceBin.html b/docs/api/WindowsRecylceBin.html index a01ddc6..15daf8d 100644 --- a/docs/api/WindowsRecylceBin.html +++ b/docs/api/WindowsRecylceBin.html @@ -92,18 +92,23 @@

RecycleBin
-
+

Provides access to the Windows recycle bin and allows to restore deleted files. +To create an instance of this class, use the static methods RecycleBin.ForCurrentUser() or RecycleBin.For(SecurityIdentifier sid).

+
RecycleBinEntry
-
+

Represents an entry of the Windows recycle bin.

+

Interfaces

IRecycleBin
-
+

Provides access to the Windows recycle bin and allows to restore deleted files. +To create an instance of this interface, use the static methods RecycleBin.ForCurrentUser() or RecycleBin.For(SecurityIdentifier sid).

+