Skip to content

Commit fbde6a5

Browse files
basicx-StrgVbasicx-StrgV
committed
Updated XML documentation
1 parent 920556b commit fbde6a5

5 files changed

Lines changed: 76 additions & 38 deletions

File tree

‎src/WGet.NET/Components/WinGetInfo.cs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ public string ExportSettings()
9595
/// Asynchronous exports the WinGet settings to a json string.
9696
/// </summary>
9797
/// <returns>
98-
/// A <see cref="System.String"/> containing the settings json.
98+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
99+
/// The result is a <see cref="System.String"/> containing the settings json.
99100
/// </returns>
100101
/// <exception cref="WGetNET.WinGetNotInstalledException">
101102
/// WinGet is not installed or not found on the system.
@@ -170,7 +171,8 @@ public bool ExportSettingsToFile(string file)
170171
/// The file for the export.
171172
/// </param>
172173
/// <returns>
173-
/// <see langword="true"/> if the action was succesfull, and <see langword="false"/> if it failed.
174+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
175+
/// The result is <see langword="true"/> if the action was succesfull, and <see langword="false"/> if it failed.
174176
/// </returns>
175177
/// <exception cref="WGetNET.WinGetNotInstalledException">
176178
/// WinGet is not installed or not found on the system.

‎src/WGet.NET/Components/WinGetPackageManager.cs‎

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ public List<WinGetPackage> SearchPackage(string packageName)
8080
/// The name of the package for the search.
8181
/// </param>
8282
/// <returns>
83-
/// A <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetPackage"/> instances.
83+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
84+
/// The result is a <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetPackage"/> instances.
8485
/// </returns>
8586
/// <exception cref="WGetNET.WinGetNotInstalledException">
8687
/// WinGet is not installed or not found on the system.
@@ -182,7 +183,8 @@ public List<WinGetPackage> GetInstalledPackages(string packageName)
182183
/// Asynchronously gets a list of all installed packages.
183184
/// </summary>
184185
/// <returns>
185-
/// A <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetPackage"/> instances.
186+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
187+
/// The result is a <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetPackage"/> instances.
186188
/// </returns>
187189
/// <exception cref="WGetNET.WinGetNotInstalledException">
188190
/// WinGet is not installed or not found on the system.
@@ -217,7 +219,8 @@ public async Task<List<WinGetPackage>> GetInstalledPackagesAsync()
217219
/// The name of the package for the search.
218220
/// </param>
219221
/// <returns>
220-
/// A <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetPackage"/> instances.
222+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
223+
/// The result is a <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetPackage"/> instances.
221224
/// </returns>
222225
/// <exception cref="WGetNET.WinGetNotInstalledException">
223226
/// WinGet is not installed or not found on the system.
@@ -318,7 +321,8 @@ public bool InstallPackage(WinGetPackage package)
318321
/// </summary>
319322
/// <param name="packageId">The id or name of the package for the installation.</param>
320323
/// <returns>
321-
/// <see langword="true"/> if the installation was successfull or <see langword="false"/> if it failed.
324+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
325+
/// The result is <see langword="true"/> if the installation was successfull or <see langword="false"/> if it failed.
322326
/// </returns>
323327
/// <exception cref="WGetNET.WinGetNotInstalledException">
324328
/// WinGet is not installed or not found on the system.
@@ -357,7 +361,8 @@ await _processManager.ExecuteWingetProcessAsync(
357361
/// </summary>
358362
/// <param name="package">The <see cref="WGetNET.WinGetPackage"/> for the installation.</param>
359363
/// <returns>
360-
/// <see langword="true"/> if the installation was successfull or <see langword="false"/> if it failed.
364+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
365+
/// The result is <see langword="true"/> if the installation was successfull or <see langword="false"/> if it failed.
361366
/// </returns>
362367
/// <exception cref="WGetNET.WinGetNotInstalledException">
363368
/// WinGet is not installed or not found on the system.
@@ -456,7 +461,8 @@ public bool UninstallPackage(WinGetPackage package)
456461
/// </summary>
457462
/// <param name="packageId">The id or name of the package for uninstallation.</param>
458463
/// <returns>
459-
/// <see langword="true"/> if the uninstallation was successfull or <see langword="false"/> if it failed.
464+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
465+
/// The result is <see langword="true"/> if the uninstallation was successfull or <see langword="false"/> if it failed.
460466
/// </returns>
461467
/// <exception cref="WGetNET.WinGetNotInstalledException">
462468
/// WinGet is not installed or not found on the system.
@@ -495,7 +501,8 @@ await _processManager.ExecuteWingetProcessAsync(
495501
/// </summary>
496502
/// <param name="package">The <see cref="WGetNET.WinGetPackage"/> for the uninstallation.</param>
497503
/// <returns>
498-
/// <see langword="true"/> if the uninstallation was successfull or <see langword="false"/> if it failed.
504+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
505+
/// The result is <see langword="true"/> if the uninstallation was successfull or <see langword="false"/> if it failed.
499506
/// </returns>
500507
/// <exception cref="WGetNET.WinGetNotInstalledException">
501508
/// WinGet is not installed or not found on the system.
@@ -559,7 +566,8 @@ public List<WinGetPackage> GetUpgradeablePackages()
559566
/// Asynchronously get all upgradeable packages.
560567
/// </summary>
561568
/// <returns>
562-
/// A <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetPackage"/> instances.
569+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
570+
/// The result is a <see cref="System.Collections.Generic.List{T}"/> of <see cref="WGetNET.WinGetPackage"/> instances.
563571
/// </returns>
564572
/// <exception cref="WGetNET.WinGetNotInstalledException">
565573
/// WinGet is not installed or not found on the system.
@@ -662,7 +670,8 @@ public bool UpgradePackage(WinGetPackage package)
662670
/// </summary>
663671
/// <param name="packageId">The id or name of the package for upgrade.</param>
664672
/// <returns>
665-
/// <see langword="true"/> if the upgrade was successfull or <see langword="false"/> if it failed.
673+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
674+
/// The result is <see langword="true"/> if the upgrade was successfull or <see langword="false"/> if it failed.
666675
/// </returns>
667676
/// <exception cref="WGetNET.WinGetNotInstalledException">
668677
/// WinGet is not installed or not found on the system.
@@ -701,7 +710,8 @@ await _processManager.ExecuteWingetProcessAsync(
701710
/// </summary>
702711
/// <param name="package">The <see cref="WGetNET.WinGetPackage"/> that for the upgrade</param>
703712
/// <returns>
704-
/// <see langword="true"/> if the upgrade was successfull or <see langword="false"/> if it failed.
713+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
714+
/// The result is <see langword="true"/> if the upgrade was successfull or <see langword="false"/> if it failed.
705715
/// </returns>
706716
/// <exception cref="WGetNET.WinGetNotInstalledException">
707717
/// WinGet is not installed or not found on the system.
@@ -783,7 +793,8 @@ public bool ExportPackagesToFile(string file)
783793
/// </summary>
784794
/// <param name="file">The file for the export.</param>
785795
/// <returns>
786-
/// <see langword="true"/> if the export was successfull or <see langword="false"/> if it failed.
796+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
797+
/// The result is <see langword="true"/> if the export was successfull or <see langword="false"/> if it failed.
787798
/// </returns>
788799
/// <exception cref="WGetNET.WinGetNotInstalledException">
789800
/// WinGet is not installed or not found on the system.
@@ -868,7 +879,8 @@ public bool ImportPackagesFromFile(string file)
868879
/// </remarks>
869880
/// <param name="file">The file with the package data for the import.</param>
870881
/// <returns>
871-
/// <see langword="true"/> if the import was compleatly successfull or
882+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
883+
/// The result is <see langword="true"/> if the import was compleatly successfull or
872884
/// <see langword="false"/> if some or all packages failed to install.
873885
/// </returns>
874886
/// <exception cref="WGetNET.WinGetNotInstalledException">
@@ -990,7 +1002,8 @@ public string Hash(FileInfo file)
9901002
/// A <see cref="System.String"/> containing the path to the file.
9911003
/// </param>
9921004
/// <returns>
993-
/// A <see cref="System.String"/> containing the hash.
1005+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
1006+
/// The result is a <see cref="System.String"/> containing the hash.
9941007
/// </returns>
9951008
public async Task<string> HashAsync(string file)
9961009
{
@@ -1029,7 +1042,8 @@ await _processManager.ExecuteWingetProcessAsync(
10291042
/// A <see cref="System.IO.FileInfo"/> object, of the file the hash should be calculated for.
10301043
/// </param>
10311044
/// <returns>
1032-
/// A <see cref="System.String"/> containing the hash.
1045+
/// A <see cref="System.Threading.Tasks.Task"/>, containing the result.
1046+
/// The result is a <see cref="System.String"/> containing the hash.
10331047
/// </returns>
10341048
public async Task<string> HashAsync(FileInfo file)
10351049
{

0 commit comments

Comments
 (0)