improve api doc

sbaeumlisberger · Oct 28, 2024 · df44313 · df44313
1 parent 1efdd6b
commit df44313
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 35 deletions.
diff --git a/WindowsRecylceBin/IRecycleBin.cs b/WindowsRecylceBin/IRecycleBin.cs
@@ -3,6 +3,10 @@
 
 namespace WindowsRecylceBin;
 
+/// <summary>
+/// Provides access to the Windows recycle bin and allows to restore deleted files.
+/// To create an instance of this interface, use the static methods <see cref="RecycleBin.ForCurrentUser">RecycleBin.ForCurrentUser()</see> or <see cref="RecycleBin.For">RecycleBin.For(SecurityIdentifier sid)</see>.
+/// </summary>
 public interface IRecycleBin
 {
     /// <summary>

diff --git a/WindowsRecylceBin/RecycleBin.cs b/WindowsRecylceBin/RecycleBin.cs
@@ -7,6 +7,10 @@
 
 namespace WindowsRecylceBin;
 
+/// <summary>
+/// Provides access to the Windows recycle bin and allows to restore deleted files.
+/// To create an instance of this class, use the static methods <see cref="RecycleBin.ForCurrentUser">RecycleBin.ForCurrentUser()</see> or <see cref="RecycleBin.For">RecycleBin.For(SecurityIdentifier sid)</see>.
+/// </summary>
 public class RecycleBin : IRecycleBin
 {
     private const string MetadataFilePrefix = "$I";

diff --git a/WindowsRecylceBin/RecycleBinEntry.cs b/WindowsRecylceBin/RecycleBinEntry.cs
@@ -2,6 +2,7 @@
 
 namespace WindowsRecylceBin;
 
+/// <summary>Represents an entry of the Windows recycle bin.</summary>
 /// <param name="OriginalFilePath">The original file path.</param>
 /// <param name="DeletedAt">The timestap when the file was deleted.</param>
 /// <param name="MetadataFilePath">The path of the metadata file in the recycle bin.</param>

diff --git a/docs/api/WindowsRecylceBin.IRecycleBin.html b/docs/api/WindowsRecylceBin.IRecycleBin.html
@@ -6,7 +6,7 @@
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
       <meta name="title" content="Interface IRecycleBin | Windows Recycle Bin ">
 
-
+      <meta name="description" content="Provides access to the Windows recycle bin and allows to restore deleted files. To create an instance of this interface, use the static methods  or .">
       <link rel="icon" href="../favicon.ico">
       <link rel="stylesheet" href="../public/docfx.min.css">
       <link rel="stylesheet" href="../public/main.css">
@@ -85,15 +85,17 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
 
 
   <h1 id="WindowsRecylceBin_IRecycleBin" data-uid="WindowsRecylceBin.IRecycleBin" class="text-break">
-Interface IRecycleBin  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L6"><i class="bi bi-code-slash"></i></a>
+Interface IRecycleBin  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L10"><i class="bi bi-code-slash"></i></a>
   </h1>
 
   <div class="facts text-secondary">
     <dl><dt>Namespace</dt><dd><a class="xref" href="WindowsRecylceBin.html">WindowsRecylceBin</a></dd></dl>
   <dl><dt>Assembly</dt><dd>WindowsRecylceBin.dll</dd></dl>
   </div>
 
-  <div class="markdown summary"></div>
+  <div class="markdown summary"><p>Provides access to the Windows recycle bin and allows to restore deleted files.
+To create an instance of this interface, use the static methods <a class="xref" href="WindowsRecylceBin.RecycleBin.html#WindowsRecylceBin_RecycleBin_ForCurrentUser">RecycleBin.ForCurrentUser()</a> or <a class="xref" href="WindowsRecylceBin.RecycleBin.html#WindowsRecylceBin_RecycleBin_For_System_Security_Principal_SecurityIdentifier_">RecycleBin.For(SecurityIdentifier sid)</a>.</p>
+</div>
   <div class="markdown conceptual"></div>
 
   <div class="codewrapper">
@@ -120,7 +122,7 @@ <h2 class="section" id="methods">Methods
 
   <h3 id="WindowsRecylceBin_IRecycleBin_DeletePernamently_WindowsRecylceBin_RecycleBinEntry_" data-uid="WindowsRecylceBin.IRecycleBin.DeletePernamently(WindowsRecylceBin.RecycleBinEntry)">
   DeletePernamently(RecycleBinEntry)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L35"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L39"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Deletes the specified recycle bin entry pernamently.</p>
@@ -153,7 +155,7 @@ <h4 class="section">Parameters</h4>
 
   <h3 id="WindowsRecylceBin_IRecycleBin_Empty" data-uid="WindowsRecylceBin.IRecycleBin.Empty">
   Empty()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L40"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L44"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Empties the recycle bin. This will delete all entries pernamently.</p>
@@ -180,7 +182,7 @@ <h3 id="WindowsRecylceBin_IRecycleBin_Empty" data-uid="WindowsRecylceBin.IRecycl
 
   <h3 id="WindowsRecylceBin_IRecycleBin_EnumerateEntries" data-uid="WindowsRecylceBin.IRecycleBin.EnumerateEntries">
   EnumerateEntries()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L11"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L15"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Enumerates all entries in the recycle bin.</p>
@@ -212,7 +214,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="WindowsRecylceBin_IRecycleBin_GetEntries" data-uid="WindowsRecylceBin.IRecycleBin.GetEntries">
   GetEntries()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L16"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L20"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets all entries in the recycle bin.</p>
@@ -244,7 +246,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="WindowsRecylceBin_IRecycleBin_Restore_System_String_" data-uid="WindowsRecylceBin.IRecycleBin.Restore(System.String)">
   Restore(string)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L29"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L33"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Restores the specified file or directory. If more than one matching entry is found, the entry with the most recent deletion time is restored.</p>
@@ -283,7 +285,7 @@ <h4 class="section">Exceptions</h4>
 
   <h3 id="WindowsRecylceBin_IRecycleBin_Restore_WindowsRecylceBin_RecycleBinEntry_" data-uid="WindowsRecylceBin.IRecycleBin.Restore(WindowsRecylceBin.RecycleBinEntry)">
   Restore(RecycleBinEntry)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L22"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L26"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Restores the specified recycle bin entry.</p>
@@ -316,7 +318,7 @@ <h4 class="section">Parameters</h4>
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L6" class="edit-link">Edit this page</a>
+          <a href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/IRecycleBin.cs/#L10" class="edit-link">Edit this page</a>
         </div>
 
 

diff --git a/docs/api/WindowsRecylceBin.RecycleBin.html b/docs/api/WindowsRecylceBin.RecycleBin.html
@@ -6,7 +6,7 @@
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
       <meta name="title" content="Class RecycleBin | Windows Recycle Bin ">
 
-
+      <meta name="description" content="Provides access to the Windows recycle bin and allows to restore deleted files. To create an instance of this class, use the static methods  or .">
       <link rel="icon" href="../favicon.ico">
       <link rel="stylesheet" href="../public/docfx.min.css">
       <link rel="stylesheet" href="../public/main.css">
@@ -85,15 +85,17 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
 
 
   <h1 id="WindowsRecylceBin_RecycleBin" data-uid="WindowsRecylceBin.RecycleBin" class="text-break">
-Class RecycleBin  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L10"><i class="bi bi-code-slash"></i></a>
+Class RecycleBin  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L14"><i class="bi bi-code-slash"></i></a>
   </h1>
 
   <div class="facts text-secondary">
     <dl><dt>Namespace</dt><dd><a class="xref" href="WindowsRecylceBin.html">WindowsRecylceBin</a></dd></dl>
   <dl><dt>Assembly</dt><dd>WindowsRecylceBin.dll</dd></dl>
   </div>
 
-  <div class="markdown summary"></div>
+  <div class="markdown summary"><p>Provides access to the Windows recycle bin and allows to restore deleted files.
+To create an instance of this class, use the static methods <a class="xref" href="WindowsRecylceBin.RecycleBin.html#WindowsRecylceBin_RecycleBin_ForCurrentUser">RecycleBin.ForCurrentUser()</a> or <a class="xref" href="WindowsRecylceBin.RecycleBin.html#WindowsRecylceBin_RecycleBin_For_System_Security_Principal_SecurityIdentifier_">RecycleBin.For(SecurityIdentifier sid)</a>.</p>
+</div>
   <div class="markdown conceptual"></div>
 
   <div class="codewrapper">
@@ -158,7 +160,7 @@ <h2 class="section" id="methods">Methods
 
   <h3 id="WindowsRecylceBin_RecycleBin_DeletePernamently_WindowsRecylceBin_RecycleBinEntry_" data-uid="WindowsRecylceBin.RecycleBin.DeletePernamently(WindowsRecylceBin.RecycleBinEntry)">
   DeletePernamently(RecycleBinEntry)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L71"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L75"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Deletes the specified recycle bin entry pernamently.</p>
@@ -191,7 +193,7 @@ <h4 class="section">Parameters</h4>
 
   <h3 id="WindowsRecylceBin_RecycleBin_Empty" data-uid="WindowsRecylceBin.RecycleBin.Empty">
   Empty()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L78"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L82"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Empties the recycle bin. This will delete all entries pernamently.</p>
@@ -218,7 +220,7 @@ <h3 id="WindowsRecylceBin_RecycleBin_Empty" data-uid="WindowsRecylceBin.RecycleB
 
   <h3 id="WindowsRecylceBin_RecycleBin_EnumerateEntries" data-uid="WindowsRecylceBin.RecycleBin.EnumerateEntries">
   EnumerateEntries()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L44"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L48"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Enumerates all entries in the recycle bin.</p>
@@ -250,7 +252,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="WindowsRecylceBin_RecycleBin_For_System_Security_Principal_SecurityIdentifier_" data-uid="WindowsRecylceBin.RecycleBin.For(System.Security.Principal.SecurityIdentifier)">
   For(SecurityIdentifier)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L39"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L43"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets the recycle bin for the specified SID.</p>
@@ -287,7 +289,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="WindowsRecylceBin_RecycleBin_ForCurrentUser" data-uid="WindowsRecylceBin.RecycleBin.ForCurrentUser">
   ForCurrentUser()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L30"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L34"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets the recycle bin for the current user.</p>
@@ -319,7 +321,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="WindowsRecylceBin_RecycleBin_GetEntries" data-uid="WindowsRecylceBin.RecycleBin.GetEntries">
   GetEntries()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L49"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L53"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets all entries in the recycle bin.</p>
@@ -351,7 +353,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="WindowsRecylceBin_RecycleBin_Restore_System_String_" data-uid="WindowsRecylceBin.RecycleBin.Restore(System.String)">
   Restore(string)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L61"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L65"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Restores the specified file or directory. If more than one matching entry is found, the entry with the most recent deletion time is restored.</p>
@@ -389,7 +391,7 @@ <h4 class="section">Exceptions</h4>
 
   <h3 id="WindowsRecylceBin_RecycleBin_Restore_WindowsRecylceBin_RecycleBinEntry_" data-uid="WindowsRecylceBin.RecycleBin.Restore(WindowsRecylceBin.RecycleBinEntry)">
   Restore(RecycleBinEntry)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L54"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L58"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Restores the specified recycle bin entry.</p>
@@ -422,7 +424,7 @@ <h4 class="section">Parameters</h4>
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L10" class="edit-link">Edit this page</a>
+          <a href="https://github.com/sbaeumlisberger/WindowsRecylceBin/blob/main/WindowsRecylceBin/RecycleBin.cs/#L14" class="edit-link">Edit this page</a>
         </div>